Options
All
  • Public
  • Public/Protected
  • All
Menu
since

1.0.0

Hierarchy

  • Type<any, any, any>
    • Any

Index

Properties

_A: any
since

1.0.0

_I: any
since

1.0.0

_O: any
since

1.0.0

encode: Encode<any, any>

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

is: Is<any>

a custom type guard

name: string

a unique name for this codec

validate: Validate<any, any>

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

Methods

  • asDecoder(): Decoder<any, any>
  • since

    1.0.0

    Returns Decoder<any, any>

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

    1.0.0

    Returns Encoder<any, any>

  • decode(i: any): Validation<any>
  • a version of validate with a default context

    since

    1.0.0

    Parameters

    • i: any

    Returns Validation<any>

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

    1.0.0

    Type parameters

    • B

    • IB

    • A

    • OB

    Parameters

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

    Returns Type<B, any, any>

Generated using TypeDoc