Class SerDe

Hierarchy

SerDe

Implements

ISerDe

Index

Constructors

Methods

deserialize getRegisteredTypeHandlers registerTypeHandler serialize unregisterTypeHandler

Constructors

constructor

new SerDe(): SerDe
Returns SerDe

Methods

deserialize

deserialize(data, options?): ISerDeDataSet
Transform writable data to usable data objects
Parameters
- data: Readonly<ISerialFormat>
- Optional options: Readonly<ISerDeOptions<TDeserializer>>
Returns ISerDeDataSet
Implementation of ISerDe.deserialize
- Defined in src/serde/serde.ts:33

getRegisteredTypeHandlers

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

Returns IterableIterator<[string, Readonly<ISerDeOperations>]>
Implementation of ISerDe.getRegisteredTypeHandlers
- Defined in src/serde/serde.ts:150

registerTypeHandler

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

serialize

serialize(data, options?): SerialFormat
Transform data objects into writable data
Parameters
- data: Readonly<ISerDeDataSet>
- Optional options: Readonly<ISerDeOptions<TSerializer>>
Returns SerialFormat
Implementation of ISerDe.serialize
- Defined in src/serde/serde.ts:165

unregisterTypeHandler

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

Generated using TypeDoc