Class UndefinedType

Since

1.0.0

Hierarchy

  • Type<undefined>
    • UndefinedType

Constructors

constructor

Properties

_A _I _O _tag encode is name validate

Methods

asDecoder asEncoder decode pipe

Constructors

constructor

Properties

Readonly _A

_A: undefined

Since

1.0.0

Readonly _I

_I: unknown

Since

1.0.0

Readonly _O

_O: undefined

Since

1.0.0

Readonly _tag

_tag: "UndefinedType"

Since

1.0.0

Readonly encode

encode: Encode<undefined, undefined>

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

Readonly is

is: Is<undefined>

a custom type guard

Readonly name

name: string

a unique name for this codec

Readonly validate

validate: Validate<unknown, undefined>

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

Methods

asDecoder

  • Since

    1.0.0

    Returns Decoder<unknown, undefined>

asEncoder

  • Since

    1.0.0

    Returns Encoder<undefined, undefined>

decode

  • a version of validate with a default context

    Since

    1.0.0

    Parameters

    • i: unknown

    Returns Validation<undefined>

pipe

  • Since

    1.0.0

    Type Parameters

    • B

    • IB

    • A

    • OB

    Parameters

    • this: Type<A, undefined, unknown>
    • ab: Type<B, OB, IB>
    • Optional name: string

    Returns Type<B, undefined, unknown>

Settings

Member Visibility

Theme

Generated using TypeDoc