Class EnumType<T>

Since

1.0.0

Type Parameters

T extends string | number

Hierarchy

Type<T>
- EnumType

Index

Constructors

Properties

_A _I _O _tag encode is name validate values

Methods

asDecoder asEncoder decode pipe

Constructors

constructor

new EnumType<T>(values: readonly T[], props: EnumTypeProps): EnumType<T>
Type Parameters
- T extends string | number
Parameters
- values: readonly T[]
- props: EnumTypeProps
Returns EnumType<T>

Overrides Type.constructor

Properties

`Readonly` _A

_A: T

Since

1.0.0

`Readonly` _I

_I: unknown

Since

1.0.0

`Readonly` _O

_O: T

Since

1.0.0

`Readonly` _tag

_tag: "EnumType" = ...

`Readonly` encode

encode: Encode<T, T>

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

`Readonly` is

is: Is<T>

a custom type guard

`Readonly` name

name: string

a unique name for this codec

`Readonly` validate

validate: Validate<unknown, T>

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

`Readonly` values

values: readonly T[]

Methods

asDecoder

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

Returns Decoder<unknown, T>

Inherited from Type.asDecoder

asEncoder

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

Returns Encoder<T, T>

Inherited from Type.asEncoder

decode

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

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

Inherited from Type.decode

pipe

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

Inherited from Type.pipe

Generated using TypeDoc