Class UnionType<CS, A, O, I>

Since

1.0.0

Type Parameters

CS extends Any[]
A = any
O = A
I = unknown

Hierarchy

Type<A, O, I>
- UnionType

Index

Constructors

Properties

_A _I _O _tag encode is name types validate

Methods

asDecoder asEncoder decode pipe

Constructors

constructor

new UnionType<CS, A, O, I>(name: string, is: Is<A>, validate: Validate<I, A>, encode: Encode<A, O>, types: CS): UnionType<CS, A, O, I>
Type Parameters
- CS extends Any[]
- A = any
- O = A
- I = unknown
Parameters
- name: string
- is: Is<A>
- validate: Validate<I, A>
- encode: Encode<A, O>
- types: CS
Returns UnionType<CS, A, O, I>

Overrides Type.constructor

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` _tag

_tag: "UnionType"

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` types

types: CS

`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>

Inherited from Type.asDecoder

asEncoder

asEncoder(): Encoder<A, O>
Since
1.0.0

Returns Encoder<A, O>

Inherited from Type.asEncoder

decode

decode(i: I): Validation<A>
a version of validate with a default context

Since
1.0.0
Parameters
- i: I
Returns Validation<A>

Inherited from Type.decode

pipe

pipe<B, IB, A, OB>(this: Type<A, O, I>, ab: Type<B, OB, IB>, name?: string): Type<B, O, I>
Since
1.0.0
Type Parameters
- B
- IB
- A
- OB
Parameters
- this: Type<A, O, I>
- ab: Type<B, OB, IB>
- Optional name: string
Returns Type<B, O, I>

Inherited from Type.pipe

Generated using TypeDoc