Class Serialization

Service that manages (de-)serialization of objects.

Hierarchy

Serialization

Index

Constructors

constructor

new Serialization(): Serialization
Returns Serialization

Properties

`Protected` `Readonly` injector

injector: Container

`Protected` serializers

serializers: Collection<RegisteredSerializer<Serializer<unknown, JSONState>>> = ...

Serializers registered with the service. We store the DI keys and realize them as needed, rather than at register time since most registration is done via the

Object Serializer

decorator and the ContainerBlueprint. Realizing them at that time can cause loops in the DI call to realizeContainer since getContainer() -> realizeContainer() -> make the serializer -> getContainer(). This largely defers the realization until after all the DI keys are registered with the global Container.

Methods

decode

decode<T>(payload: SerialPayload<unknown, JSONState>, validator?: Validator<T>): Awaitable<T>
Decode a serial payload to the original object using a registered serializer, if one exists.

Throws
NoSerializerError
Type Parameters
- T
Parameters
- payload: SerialPayload<unknown, JSONState>
- Optional validator: Validator<T>
Returns Awaitable<T>
- Defined in src/support/bus/serial/Serialization.ts:139

decodeJSON

decodeJSON<T>(payload: string, validator?: Validator<T>): Promise<T>
Decode a value from JSON using a registered serializer, if one exists.

Throws
NoSerializerError
Type Parameters
- T
Parameters
- payload: string
- Optional validator: Validator<T>
Returns Promise<T>
- Defined in src/support/bus/serial/Serialization.ts:155

encode

encode<T>(value: T): Awaitable<SerialPayload<T, JSONState>>
Encode a value to its serial payload using a registered serializer, if one exists.

Throws
NoSerializerError
Type Parameters
- T
Parameters
- value: T
Returns Awaitable<SerialPayload<T, JSONState>>
- Defined in src/support/bus/serial/Serialization.ts:120

encodeJSON

encodeJSON<T>(value: T): Promise<string>
Encode a value to JSON using a registered serializer, if one exists.

Throws
NoSerializerError
Type Parameters
- T
Parameters
- value: T
Returns Promise<string>
- Defined in src/support/bus/serial/Serialization.ts:129

`Protected` matchActual

matchActual<T>(actual: T): Serializer<T, JSONState>
Type Parameters
- T
Parameters
- actual: T
Returns Serializer<T, JSONState>
- Defined in src/support/bus/serial/Serialization.ts:87

`Protected` matchSerial

matchSerial<TSerial>(serial: SerialPayload<unknown, TSerial>): Serializer<unknown, TSerial>
Type Parameters
- TSerial extends JSONState
Parameters
- serial: SerialPayload<unknown, TSerial>
Returns Serializer<unknown, TSerial>
- Defined in src/support/bus/serial/Serialization.ts:101

register

register(key: Instantiable<Serializer<unknown, JSONState>>): Serialization
Register a new serializer with the service.
Parameters
- key: Instantiable<Serializer<unknown, JSONState>>
Returns Serialization
- Defined in src/support/bus/serial/Serialization.ts:67

registerInstance

registerInstance(key: Instantiable<Serializer<unknown, JSONState>>, instance: Serializer<unknown, JSONState>): Serialization
Register an already-realized serializer instance with this service.
Parameters
- key: Instantiable<Serializer<unknown, JSONState>>
- instance: Serializer<unknown, JSONState>
Returns Serialization
- Defined in src/support/bus/serial/Serialization.ts:77

Class Serialization

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Serialization

Properties

Protected Readonly injector

Protected serializers

Object Serializer

Methods

decode

Throws

Type Parameters

T

Parameters

payload: SerialPayload<unknown, JSONState>

Optional validator: Validator<T>

Returns Awaitable<T>

decodeJSON

Throws

Type Parameters

T

Parameters

payload: string

Optional validator: Validator<T>

Returns Promise<T>

encode

Throws

Type Parameters

T

Parameters

value: T

Returns Awaitable<SerialPayload<T, JSONState>>

encodeJSON

Throws

Type Parameters

T

Parameters

value: T

Returns Promise<string>

Protected matchActual

Type Parameters

T

Parameters

actual: T

Returns Serializer<T, JSONState>

Protected matchSerial

Type Parameters

TSerial extends JSONState

Parameters

serial: SerialPayload<unknown, TSerial>

Returns Serializer<unknown, TSerial>

register

Parameters

key: Instantiable<Serializer<unknown, JSONState>>

Returns Serialization

registerInstance

Parameters

key: Instantiable<Serializer<unknown, JSONState>>

instance: Serializer<unknown, JSONState>

Returns Serialization

Settings

Member Visibility

Theme

`Protected` `Readonly` injector

`Protected` serializers

`Optional` validator: Validator<T>

`Optional` validator: Validator<T>

`Protected` matchActual

`Protected` matchSerial