Class Schema<T, E>`Abstract`

Define a schema to encode / decode convert type T to type E.

Type Parameters

T
E

Hierarchy (view full)

Schema

Index

Constructors

Methods

decode decodeInternal encode encodeInternal validate

Constructors

constructor

new Schema<T, E>(): Schema<T, E>
Type Parameters
- T
- E
Returns Schema<T, E>

Methods

decode

decode(encoded, validate?): T
Decodes the encoded data using the schema.
Parameters
- encoded: E
- validate: boolean = true
Returns T
- Defined in packages/types/src/schema/Schema.ts:16

`Protected` `Abstract`decodeInternal

decodeInternal(encoded): T
Parameters
- encoded: E
Returns T
- Defined in packages/types/src/schema/Schema.ts:25

encode

encode(value): E
Encodes the value using the schema.
Parameters
- value: T
Returns E
- Defined in packages/types/src/schema/Schema.ts:10

`Protected` `Abstract`encodeInternal

encodeInternal(value): E
Parameters
- value: T
Returns E
- Defined in packages/types/src/schema/Schema.ts:24

validate

validate(_value): void
Optional validator that can be used to enforce constraints on the data before encoding / after decoding.
Parameters
- _value: T
Returns void
- Defined in packages/types/src/schema/Schema.ts:28