DecodeError overview

This module is experimental

Experimental features are published in order to get early feedback from the community, see these tracking issues for further discussions and enhancements.

A feature tagged as Experimental is in a high state of flux, you’re at risk of it changing without notice.

Added in v2.2.7

---

Table of contents

• constructors
  • index
  • key
  • lazy
  • leaf
  • member
  • wrap
• destructors
  • fold
• instances
  • getSemigroup
• model
  • DecodeError (type alias)
  • Index (interface)
  • Key (interface)
  • Kind (type alias)
  • Lazy (interface)
  • Leaf (interface)
  • Member (interface)
  • Wrap (interface)
  • optional
  • required

---

constructors

index

Signature

export declare const index: <E>(index: number, kind: Kind, errors: FS.FreeSemigroup<DecodeError<E>>) => DecodeError<E>

Added in v2.2.7

key

Signature

export declare const key: <E>(key: string, kind: Kind, errors: FS.FreeSemigroup<DecodeError<E>>) => DecodeError<E>

Added in v2.2.7

lazy

Signature

export declare const lazy: <E>(id: string, errors: FS.FreeSemigroup<DecodeError<E>>) => DecodeError<E>

Added in v2.2.7

leaf

Signature

export declare const leaf: <E>(actual: unknown, error: E) => DecodeError<E>

Added in v2.2.7

member

Signature

export declare const member: <E>(index: number, errors: FS.FreeSemigroup<DecodeError<E>>) => DecodeError<E>

Added in v2.2.7

wrap

Signature

export declare const wrap: <E>(error: E, errors: FS.FreeSemigroup<DecodeError<E>>) => DecodeError<E>

Added in v2.2.9

destructors

fold

Signature

export declare const fold: <E, R>(patterns: {
  Leaf: (input: unknown, error: E) => R
  Key: (key: string, kind: Kind, errors: FS.FreeSemigroup<DecodeError<E>>) => R
  Index: (index: number, kind: Kind, errors: FS.FreeSemigroup<DecodeError<E>>) => R
  Member: (index: number, errors: FS.FreeSemigroup<DecodeError<E>>) => R
  Lazy: (id: string, errors: FS.FreeSemigroup<DecodeError<E>>) => R
  Wrap: (error: E, errors: FS.FreeSemigroup<DecodeError<E>>) => R
}) => (e: DecodeError<E>) => R

Added in v2.2.7

instances

getSemigroup

Signature

export declare function getSemigroup<E = never>(): Semigroup<FS.FreeSemigroup<DecodeError<E>>>

Added in v2.2.7

model

DecodeError (type alias)

Signature

export type DecodeError<E> = Leaf<E> | Key<E> | Index<E> | Member<E> | Lazy<E> | Wrap<E>

Added in v2.2.7

Index (interface)

Signature

export interface Index<E> {
  readonly _tag: 'Index'
  readonly index: number
  readonly kind: Kind
  readonly errors: FS.FreeSemigroup<DecodeError<E>>
}

Added in v2.2.7

Key (interface)

Signature

export interface Key<E> {
  readonly _tag: 'Key'
  readonly key: string
  readonly kind: Kind
  readonly errors: FS.FreeSemigroup<DecodeError<E>>
}

Added in v2.2.7

Kind (type alias)

Signature

export type Kind = 'required' | 'optional'

Added in v2.2.7

Lazy (interface)

Signature

export interface Lazy<E> {
  readonly _tag: 'Lazy'
  readonly id: string
  readonly errors: FS.FreeSemigroup<DecodeError<E>>
}

Added in v2.2.7

Leaf (interface)

Signature

export interface Leaf<E> {
  readonly _tag: 'Leaf'
  readonly actual: unknown
  readonly error: E
}

Added in v2.2.7

Member (interface)

Signature

export interface Member<E> {
  readonly _tag: 'Member'
  readonly index: number
  readonly errors: FS.FreeSemigroup<DecodeError<E>>
}

Added in v2.2.7

Wrap (interface)

Signature

export interface Wrap<E> {
  readonly _tag: 'Wrap'
  readonly error: E
  readonly errors: FS.FreeSemigroup<DecodeError<E>>
}

Added in v2.2.9

optional

Signature

export declare const optional: 'optional'

Added in v2.2.7

required

Signature

export declare const required: 'required'

Added in v2.2.7