Class ModelSerializer

A core Serializer implementation.

Hierarchy

BaseSerializer<Model<any>, ModelSerialPayload>
- ModelSerializer

Index

Constructors

Properties

Methods

decode decodeSerial encode encodeActual getName getRequest getSerialization make matchActual matchSerial

Constructors

constructor

new ModelSerializer(): ModelSerializer
Returns ModelSerializer

Inherited from BaseSerializer.constructor

Properties

`Protected` `Readonly` canon

canon: Canon

Methods

decode

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

`Protected` decodeSerial

decodeSerial(serial: ModelSerialPayload): Promise<Model<any>>
Decode the payload back to the original object.
Parameters
- serial: ModelSerialPayload
Returns Promise<Model<any>>
Overrides BaseSerializer.decodeSerial
- Defined in src/orm/model/ModelSerializer.ts:20

encode

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

`Protected` encodeActual

encodeActual(actual: Model<any>): Awaitable<ModelSerialPayload>
Encode the payload as a JSON state.
Parameters
- actual: Model<any>
Returns Awaitable<ModelSerialPayload>
Overrides BaseSerializer.encodeActual
- Defined in src/orm/model/ModelSerializer.ts:45

`Protected` getName

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

Returns string
Overrides BaseSerializer.getName
- Defined in src/orm/model/ModelSerializer.ts:61

`Protected` getRequest

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

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

`Protected` getSerialization

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

Returns Serialization
Inherited from BaseSerializer.getSerialization
- 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
Inherited from BaseSerializer.make
- Defined in src/support/bus/serial/BaseSerializer.ts:80

matchActual

matchActual(some: Model<any>): boolean
Return true if the value can be encoded by this serializer.
Parameters
- some: Model<any>
Returns boolean
Overrides BaseSerializer.matchActual
- Defined in src/orm/model/ModelSerializer.ts:65

matchSerial

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