Interface ISerDe

Hierarchy

ISerDe

Implemented by

SerDe

Index

Methods

deserialize getRegisteredTypeHandlers registerTypeHandler serialize unregisterTypeHandler

Methods

deserialize

deserialize(data, options?): ISerDeDataSet
Transform writable data to usable data objects
Parameters
- data: Readonly<ISerialFormat>
- Optional options: 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, deserializer, serializer): 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, options?): ISerialFormat
Transform data objects into writable data
Parameters
- data: Readonly<ISerDeDataSet>
- Optional options: Readonly<ISerDeOptions<TSerializer>>
Returns ISerialFormat
- Defined in src/serde/serde.spec.ts:68

unregisterTypeHandler

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

Generated using TypeDoc