Interface ISerDe

interface ISerDe {
    deserialize(
        data: Readonly<ISerialFormat>,
        options?: Readonly<ISerDeOptions<TDeserializer>>,
    ): ISerDeDataSet;
    getRegisteredTypeHandlers(): IterableIterator<
        [string, Readonly<ISerDeOperations>],
    >;
    registerTypeHandler(
        Type: Readonly<TObjectProto>,
        deserializer: TCustomDeserializer,
        serializer: TSerializer,
    ): void;
    serialize(
        data: Readonly<ISerDeDataSet>,
        options?: Readonly<ISerDeOptions<TSerializer>>,
    ): ISerialFormat;
    unregisterTypeHandler(Type: Readonly<TObjectProto>): void;
}

Implemented by

SerDe

Index

Methods

deserialize getRegisteredTypeHandlers registerTypeHandler serialize unregisterTypeHandler

Methods

deserialize

deserialize(
data: Readonly<ISerialFormat>,
options?: Readonly<ISerDeOptions<TDeserializer>>,
): ISerDeDataSet
Transform writable data to usable data objects
Parameters
- data: Readonly<ISerialFormat>
- Optionaloptions: Readonly<ISerDeOptions<TDeserializer>>
Returns ISerDeDataSet
- Defined in src/serde/serde.spec.ts:48

getRegisteredTypeHandlers

getRegisteredTypeHandlers(): IterableIterator<
[string, Readonly<ISerDeOperations>],
>
Get an overview over all registered type handlers; useful for debugging

Returns IterableIterator<[string, Readonly<ISerDeOperations>]>
- Defined in src/serde/serde.spec.ts:53

registerTypeHandler

registerTypeHandler(
    Type: Readonly<TObjectProto>,
    deserializer: TCustomDeserializer,
    serializer: TSerializer,
): void
Register type handlers for transformations
Parameters
- Type: Readonly<TObjectProto>
- deserializer: TCustomDeserializer
- serializer: TSerializer
Returns void
- Defined in src/serde/serde.spec.ts:61

serialize

serialize(
data: Readonly<ISerDeDataSet>,
options?: Readonly<ISerDeOptions<TSerializer>>,
): ISerialFormat
Transform data objects into writable data
Parameters
- data: Readonly<ISerDeDataSet>
- Optionaloptions: Readonly<ISerDeOptions<TSerializer>>
Returns ISerialFormat
- Defined in src/serde/serde.spec.ts:68

unregisterTypeHandler

unregisterTypeHandler(Type: Readonly<TObjectProto>): void
Remove a type handler registration
Parameters
- Type: Readonly<TObjectProto>
Returns void
- Defined in src/serde/serde.spec.ts:74