Class OptionalType<T>

Since

1.0.0

Type Parameters

Hierarchy

  • Type<T["_A"] | undefined, T["_O"] | undefined, T["_I"] | undefined>
    • OptionalType

Constructors

constructor

Properties

_A _I _O encode is name type validate

Methods

asDecoder asEncoder decode pipe

Constructors

constructor

Properties

Readonly _A

_A: undefined | T["_A"]

Since

1.0.0

Readonly _I

_I: undefined | T["_I"]

Since

1.0.0

Readonly _O

_O: undefined | T["_O"]

Since

1.0.0

Readonly encode

encode: Encode<undefined | T["_A"], undefined | T["_O"]>

converts a value of type A to a value of type O

Readonly is

is: Is<undefined | T["_A"]>

a custom type guard

Readonly name

name: string

a unique name for this codec

Readonly type

type: T

Readonly validate

validate: Validate<undefined | T["_I"], undefined | T["_A"]>

succeeds if a value of type I can be decoded to a value of type A

Methods

asDecoder

  • Since

    1.0.0

    Returns Decoder<undefined | T["_I"], undefined | T["_A"]>

asEncoder

  • Since

    1.0.0

    Returns Encoder<undefined | T["_A"], undefined | T["_O"]>

decode

  • a version of validate with a default context

    Since

    1.0.0

    Parameters

    • i: undefined | T["_I"]

    Returns Validation<undefined | T["_A"]>

pipe

  • Since

    1.0.0

    Type Parameters

    • B

    • IB

    • A

    • OB

    Parameters

    • this: Type<A, undefined | T["_O"], undefined | T["_I"]>
    • ab: Type<B, OB, IB>
    • Optional name: string

    Returns Type<B, undefined | T["_O"], undefined | T["_I"]>

Settings

Member Visibility

Theme

Generated using TypeDoc