Class BaseSerializer<TActual, TSerial>`Abstract`

A core Serializer implementation.

Type Parameters

TActual
TSerial extends JSONState

Hierarchy

BaseSerializer

Index

Constructors

Methods

decode decodeSerial encode encodeActual getName getRequest getSerialization make matchActual matchSerial

Constructors

constructor

new BaseSerializer<TActual, TSerial>(): BaseSerializer<TActual, TSerial>
Type Parameters
- TActual
- TSerial extends JSONState
Returns BaseSerializer<TActual, TSerial>

Methods

decode

decode(serial: SerialPayload<TActual, TSerial>): Promise<TActual>
Decode a value from a serial payload.
Parameters
- serial: SerialPayload<TActual, TSerial>
Returns Promise<TActual>
- Defined in src/support/bus/serial/BaseSerializer.ts:62

`Protected` `Abstract` decodeSerial

decodeSerial(serial: TSerial): Awaitable<TActual>
Protected
Decode the payload back to the original object.
Parameters
- serial: TSerial
Returns Awaitable<TActual>
- Defined in src/support/bus/serial/BaseSerializer.ts:39

encode

encode(actual: TActual): Promise<SerialPayload<TActual, TSerial>>
Encode a value to a serial payload.
Parameters
- actual: TActual
Returns Promise<SerialPayload<TActual, TSerial>>
- Defined in src/support/bus/serial/BaseSerializer.ts:51

`Protected` `Abstract` encodeActual

encodeActual(actual: TActual): Awaitable<TSerial>
Protected
Encode the payload as a JSON state.
Parameters
- actual: TActual
Returns Awaitable<TSerial>
- Defined in src/support/bus/serial/BaseSerializer.ts:32

`Protected` `Abstract` getName

getName(): string
Protected
Get the unique name of this serializer.

Returns string
- Defined in src/support/bus/serial/BaseSerializer.ts:45

`Protected` getRequest

getRequest(): Request
Helper to get an instance of the global Request.

Returns Request
- Defined in src/support/bus/serial/BaseSerializer.ts:73

`Protected` getSerialization

getSerialization(): Serialization
Helper to get an instance of the Serialization service.

Returns Serialization
- Defined in src/support/bus/serial/BaseSerializer.ts:67

`Protected` make

make<T>(key: any): T
Get a dependency from the container.
Type Parameters
- T
Parameters
- key: any
Returns T
- Defined in src/support/bus/serial/BaseSerializer.ts:80

`Abstract` matchActual

matchActual(some: TActual): boolean
Return true if the value can be encoded by this serializer.
Parameters
- some: TActual
Returns boolean
- Defined in src/support/bus/serial/BaseSerializer.ts:17

matchSerial

matchSerial(serial: SerialPayload<TActual, TSerial>): boolean
Return true if the serial payload can be decoded by this serializer.
Parameters
- serial: SerialPayload<TActual, TSerial>
Returns boolean
- Defined in src/support/bus/serial/BaseSerializer.ts:23