Interface ISerderRegister

The ISerderRegister contract defines a standard way to register custom serialization and deserialization logic.

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

interface ISerderRegister {
    registerClass<TSerializedClassInstance extends SerializedValueBase>(
        class_: SerializableClass<TSerializedClassInstance>,
        prefix?: OneOrMore<string>,
    ): this;
    registerCustom<
        TCustomDeserialized,
        TCustomSerialized extends SerializedValueBase,
    >(
        transformer: ISerdeTransformer<TCustomDeserialized, TCustomSerialized>,
        prefix?: OneOrMore<string>,
    ): this;
}

Index

Methods

registerClass registerCustom

Methods

registerClass

registerClass<TSerializedClassInstance extends SerializedValueBase>(
class_: SerializableClass<TSerializedClassInstance>,
prefix?: OneOrMore<string>,
): 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 extends SerializedValueBase
Parameters
- class_: SerializableClass<TSerializedClassInstance>
- Optionalprefix: OneOrMore<string>
Returns this
- Defined in src/serde/contracts/flexible-serde.contract.ts:69

registerCustom

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