Class Type<A, O, I>

since: 1.0.0

Type parameters

A
O = A
I = unknown

Hierarchy

Type

Implements

Decoder<I, A>
Encoder<A, O>

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Type<A, O, I>(name: string, is: Is<A>, validate: Validate<I, A>, encode: Encode<A, O>): Type<A, O, I>

Type parameters
- A
- O = A
- I = unknown
Parameters
- name: string
- is: Is<A>
- validate: Validate<I, A>
- encode: Encode<A, O>
Returns Type<A, O, I>

Properties

Readonly _A

_A: A

since: 1.0.0

Readonly _I

_I: I

since: 1.0.0

Readonly _O

_O: O

since: 1.0.0

Readonly encode

encode: Encode<A, O>

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

Readonly is

is: Is<A>

a custom type guard

Readonly name

name: string

a unique name for this codec

Readonly validate

validate: Validate<I, A>

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

Methods

asDecoder

asDecoder(): Decoder<I, A>

since
1.0.0

Returns Decoder<I, A>

asEncoder

asEncoder(): Encoder<A, O>

since
1.0.0

Returns Encoder<A, O>

decode

decode(i: I): Validation<A>

Implementation of Decoder.decode

a version of validate with a default context

since
1.0.0

Parameters
- i: I
Returns Validation<A>

pipe

pipe<B, IB, A, OB>(ab: Type<B, OB, IB>, name?: string): Type<B, O, I>

since
1.0.0

Type parameters
- B
- IB
- A
- OB
Parameters
- ab: Type<B, OB, IB>
- Optional name: string
Returns Type<B, O, I>

Generated using TypeDoc