Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TypeC<P>

since

1.5.3

Type parameters

Hierarchy

  • InterfaceType<P, { [ K in keyof P]: TypeOf<P[K]> }, { [ K in keyof P]: OutputOf<P[K]> }, unknown>
    • TypeC

Index

Properties

Methods

Properties

Readonly _A

_A: { [ K in string | number | symbol]: TypeOf<P[K]> }
since

1.0.0

Readonly _I

_I: unknown
since

1.0.0

Readonly _O

_O: { [ K in string | number | symbol]: OutputOf<P[K]> }
since

1.0.0

Readonly _tag

_tag: "InterfaceType"
since

1.0.0

Readonly encode

encode: Encode<{ [ K in string | number | symbol]: TypeOf<P[K]> }, { [ K in string | number | symbol]: OutputOf<P[K]> }>

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

Readonly is

is: Is<{ [ K in string | number | symbol]: TypeOf<P[K]> }>

a custom type guard

Readonly name

name: string

a unique name for this codec

Readonly props

props: P

Readonly validate

validate: Validate<unknown, { [ K in string | number | symbol]: TypeOf<P[K]> }>

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

Methods

asDecoder

  • asDecoder(): Decoder<unknown, { [ K in string | number | symbol]: TypeOf<P[K]> }>

asEncoder

  • asEncoder(): Encoder<{ [ K in string | number | symbol]: TypeOf<P[K]> }, { [ K in string | number | symbol]: OutputOf<P[K]> }>
  • since

    1.0.0

    Returns Encoder<{ [ K in string | number | symbol]: TypeOf<P[K]> }, { [ K in string | number | symbol]: OutputOf<P[K]> }>

decode

  • decode(i: unknown): Validation<{ [ K in string | number | symbol]: TypeOf<P[K]> }>

  • a version of validate with a default context

    since

    1.0.0

    Parameters

    • i: unknown

    Returns Validation<{ [ K in string | number | symbol]: TypeOf<P[K]> }>

pipe

  • pipe<B, IB, A, OB>(ab: Type<B, OB, IB>, name?: string): Type<B, { [ K in string | number | symbol]: OutputOf<P[K]> }, unknown>
  • since

    1.0.0

    Type parameters

    • B

    • IB

    • A

    • OB

    Parameters

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

    Returns Type<B, { [ K in string | number | symbol]: OutputOf<P[K]> }, unknown>

Generated using TypeDoc