Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LiteralType<V>

since

1.0.0

Type parameters

  • V: LiteralValue

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new LiteralType<V>(name: string, is: Is<V>, validate: Validate<unknown, V>, encode: Encode<V, V>, value: V): LiteralType<V>

  • Type parameters

    • V: LiteralValue

    Parameters

    • name: string
    • is: Is<V>
    • validate: Validate<unknown, V>
    • encode: Encode<V, V>
    • value: V

    Returns LiteralType<V>

Properties

Readonly _A

_A: V
since

1.0.0

Readonly _I

_I: unknown
since

1.0.0

Readonly _O

_O: V
since

1.0.0

Readonly _tag

_tag: "LiteralType"
since

1.0.0

Readonly encode

encode: Encode<V, V>

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

Readonly is

is: Is<V>

a custom type guard

Readonly name

name: string

a unique name for this codec

Readonly validate

validate: Validate<unknown, V>

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

Readonly value

value: V

Methods

asDecoder

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

    1.0.0

    Returns Decoder<unknown, V>

asEncoder

  • asEncoder(): Encoder<V, V>

decode

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

  • a version of validate with a default context

    since

    1.0.0

    Parameters

    • i: unknown

    Returns Validation<V>

pipe

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

    1.0.0

    Type parameters

    • B

    • IB

    • A

    • OB

    Parameters

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

    Returns Type<B, V, unknown>

Generated using TypeDoc