Class EnumType<A>

Type Parameters

A

Hierarchy

Type<A>
- EnumType

Index

Constructors

Properties

_A _I _O _tag encode enumObject is name validate

Methods

asDecoder asEncoder decode pipe

Constructors

constructor

new EnumType<A>(e: object, name?: string): EnumType<A>
Type Parameters
- A
Parameters
- e: object
- Optional name: string
Returns EnumType<A>
Overrides t.Type<A>.constructor
- Defined in src/operations/commons/types.ts:12

Properties

`Readonly` _A

_A: A

Since

1.0.0

`Readonly` _I

_I: unknown

Since

1.0.0

`Readonly` _O

_O: A

Since

1.0.0

`Readonly` _tag

_tag: "EnumType" = 'EnumType'

`Readonly` encode

encode: Encode<A, A>

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

enumObject

enumObject: object

`Readonly` is

is: Is<A>

a custom type guard

`Readonly` name

name: string

a unique name for this codec

`Readonly` validate

validate: Validate<unknown, A>

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

Methods

asDecoder

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

Returns Decoder<unknown, A>
Inherited from t.Type.asDecoder
- Defined in node_modules/io-ts/lib/index.d.ts:155

asEncoder

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

Returns Encoder<A, A>
Inherited from t.Type.asEncoder
- Defined in node_modules/io-ts/lib/index.d.ts:159

decode

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

Since
1.0.0
Parameters
- i: unknown
Returns Validation<A>
Inherited from t.Type.decode
- Defined in node_modules/io-ts/lib/index.d.ts:164

pipe

pipe<B, IB, A, OB>(this: Type<A, A, unknown>, ab: Type<B, OB, IB>, name?: string): Type<B, A, unknown>
Since
1.0.0
Type Parameters
- B
- IB
- A
- OB
Parameters
- this: Type<A, A, unknown>
- ab: Type<B, OB, IB>
- Optional name: string
Returns Type<B, A, unknown>
Inherited from t.Type.pipe
- Defined in node_modules/io-ts/lib/index.d.ts:151