Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UndefinedType

since

1.0.0

Hierarchy

  • Type<undefined>
    • UndefinedType

Index

Constructors

Properties

Methods

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

  • asDecoder(): Decoder<unknown, undefined>
  • since

    1.0.0

    Returns Decoder<unknown, undefined>

asEncoder

  • asEncoder(): Encoder<undefined, undefined>
  • since

    1.0.0

    Returns Encoder<undefined, undefined>

decode

  • decode(i: unknown): Validation<undefined>

  • a version of validate with a default context

    since

    1.0.0

    Parameters

    • i: unknown

    Returns Validation<undefined>

pipe

  • pipe<B, IB, A, OB>(ab: Type<B, OB, IB>, name?: string): Type<B, undefined, unknown>
  • since

    1.0.0

    Type parameters

    • B

    • IB

    • A

    • OB

    Parameters

    • ab: Type<B, OB, IB>
    • Optional name: string

    Returns Type<B, undefined, unknown>

Generated using TypeDoc