Interface IFlexibleSerde<TSerializedValue>

The IFlexibleSerde contract defines a standard way to serialize and deserialize both plain data and custom classes.

IMPORT_PATH: "@daiso-tech/core/serde/contracts"

interface IFlexibleSerde<TSerializedValue> {
    deserialize<TValue>(serializedValue: TSerializedValue): TValue;
    registerClass<TSerializedClassInstance>(class_: SerializableClass<TSerializedClassInstance>, prefix?: OneOrMore<string>): this;
    registerCustom<TCustomSerialized, TCustomDeserialized>(transformer: ISerdeTransformer<TCustomSerialized, TCustomDeserialized>, prefix?: OneOrMore<string>): this;
    registerEvent<TFields>(eventClass: SerializableEventClass<TFields>, prefix?: OneOrMore<string>): this;
    serialize<TValue>(value: TValue): TSerializedValue;
}

Type Parameters

TSerializedValue = unknown

Hierarchy (view full)

ISerde<TSerializedValue>
- IFlexibleSerde

Implemented by

Serde

Index

Methods

deserialize registerClass registerCustom registerEvent serialize

Methods

deserialize

deserialize<TValue>(serializedValue): TValue
Type Parameters
- TValue
Parameters
- serializedValue: TSerializedValue
Returns TValue
Throws
DeserializationError
Inherited from ISerde.deserialize
- Defined in src/serde/contracts/deserializer.contract.ts:20

registerClass

registerClass<TSerializedClassInstance>(class_, prefix?): this
The registerClass method is used for registering custom class for serialization and deserialization. The class_ parameter must be of type SerializableClass.
Type Parameters
- TSerializedClassInstance
Parameters
- class_: SerializableClass<TSerializedClassInstance>
- Optionalprefix: OneOrMore<string>
Returns this
- Defined in src/serde/contracts/flexible-serde.contract.ts:66

registerCustom

registerCustom<TCustomSerialized, TCustomDeserialized>(transformer, prefix?): this
The registerCustom method is used for registering custom values for serialization and deserialization.
Type Parameters
- TCustomSerialized
- TCustomDeserialized
Parameters
- transformer: ISerdeTransformer<TCustomSerialized, TCustomDeserialized>
- Optionalprefix: OneOrMore<string>
Returns this
- Defined in src/serde/contracts/flexible-serde.contract.ts:74

registerEvent

registerEvent<TFields>(eventClass, prefix?): this
The registerEvent method is used for registering custom BaseEvent for serialization and deserialization.
Type Parameters
- TFields extends Record<string, unknown>
Parameters
- eventClass: SerializableEventClass<TFields>
- Optionalprefix: OneOrMore<string>
Returns this
- Defined in src/serde/contracts/flexible-serde.contract.ts:57

serialize

serialize<TValue>(value): TSerializedValue
Type Parameters
- TValue
Parameters
- value: TValue
Returns TSerializedValue
Throws
SerializationError
Inherited from ISerde.serialize
- Defined in src/serde/contracts/serializer.contract.ts:19