Class LiteralType<V>

Since

1.0.0

Type Parameters

V extends LiteralValue

Hierarchy

Type<V>
- LiteralType

Index

Constructors

Properties

_A _I _O _tag encode is name validate value

Methods

asDecoder asEncoder decode pipe

Constructors

constructor

new LiteralType<V>(name: string, is: Is<V>, validate: Validate<unknown, V>, encode: Encode<V, V>, value: V): LiteralType<V>
Type Parameters
- V extends LiteralValue
Parameters
- name: string
- is: Is<V>
- validate: Validate<unknown, V>
- encode: Encode<V, V>
- value: V
Returns LiteralType<V>

Overrides Type.constructor

Properties

`Readonly` _A

_A: V

Since

1.0.0

`Readonly` _I

_I: unknown

Since

1.0.0

`Readonly` _O

_O: V

Since

1.0.0

`Readonly` _tag

_tag: "LiteralType"

Since

1.0.0

`Readonly` encode

encode: Encode<V, V>

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

`Readonly` is

is: Is<V>

a custom type guard

`Readonly` name

name: string

a unique name for this codec

`Readonly` validate

validate: Validate<unknown, V>

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

`Readonly` value

value: V

Methods

asDecoder

asDecoder(): Decoder<unknown, V>
Since
1.0.0

Returns Decoder<unknown, V>

Inherited from Type.asDecoder

asEncoder

asEncoder(): Encoder<V, V>
Since
1.0.0

Returns Encoder<V, V>

Inherited from Type.asEncoder

decode

decode(i: unknown): Validation<V>
a version of validate with a default context

Since
1.0.0
Parameters
- i: unknown
Returns Validation<V>

Inherited from Type.decode

pipe

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

Inherited from Type.pipe

Generated using TypeDoc