Class DefaultedType<T>

Since

1.0.0

Type Parameters

T extends Any

Hierarchy

Type<T["_A"], T["_O"], T["_I"]>
- DefaultedType

Index

Constructors

Properties

_A _I _O defaultValue encode is name type validate

Methods

asDecoder asEncoder decode pipe

Constructors

constructor

new DefaultedType<T>(type: T, defaultValue: T["_A"], name?: string): DefaultedType<T>
Type Parameters
- T extends Any<T>
Parameters
- type: T
- defaultValue: T["_A"]
- Optional name: string
Returns DefaultedType<T>

Overrides Type.constructor

Properties

`Readonly` _A

_A: T["_A"]

Since

1.0.0

`Readonly` _I

_I: T["_I"]

Since

1.0.0

`Readonly` _O

_O: T["_O"]

Since

1.0.0

`Readonly` defaultValue

defaultValue: T["_A"]

`Readonly` encode

encode: Encode<T["_A"], T["_O"]>

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

`Readonly` is

is: Is<T["_A"]>

a custom type guard

`Readonly` name

name: string

a unique name for this codec

`Readonly` type

type: T

`Readonly` validate

validate: Validate<T["_I"], T["_A"]>

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

Methods

asDecoder

asDecoder(): Decoder<T["_I"], T["_A"]>
Since
1.0.0

Returns Decoder<T["_I"], T["_A"]>

Inherited from Type.asDecoder

asEncoder

asEncoder(): Encoder<T["_A"], T["_O"]>
Since
1.0.0

Returns Encoder<T["_A"], T["_O"]>

Inherited from Type.asEncoder

decode

decode(i: T["_I"]): Validation<T["_A"]>
a version of validate with a default context

Since
1.0.0
Parameters
- i: T["_I"]
Returns Validation<T["_A"]>

Inherited from Type.decode

pipe

pipe<B, IB, A, OB>(this: Type<A, T["_O"], T["_I"]>, ab: Type<B, OB, IB>, name?: string): Type<B, T["_O"], T["_I"]>
Since
1.0.0
Type Parameters
- B
- IB
- A
- OB
Parameters
- this: Type<A, T["_O"], T["_I"]>
- ab: Type<B, OB, IB>
- Optional name: string
Returns Type<B, T["_O"], T["_I"]>

Inherited from Type.pipe

Generated using TypeDoc