Class Serializer

Index

Constructors

Methods

addType deserialize parse serialize stringify

Constructors

constructor

new Serializer(options?: SerializerOptions): Serializer
Parameters
- options: SerializerOptions = {}
Returns Serializer
- Defined in src/serializer/Serializer.ts:67

Methods

addType

addType<TInstance, TSerialized>(
typeDef: TypeDefinition<TInstance, TSerialized>,
): void
Register a custom type for serialization/deserialization.
Type Parameters
- TInstance
- TSerialized
Parameters
- typeDef: TypeDefinition<TInstance, TSerialized>
Returns void
- Defined in src/serializer/Serializer.ts:176

deserialize

deserialize<T = unknown>(payload: string): T
Deserialize a JSON string back to its original value.
Type Parameters
- T = unknown
Parameters
- payload: string
Returns T
- Defined in src/serializer/Serializer.ts:151

parse

parse<T = unknown>(payload: string): T
Alias of deserialize() to match the historical tunnel serializer surface.
Type Parameters
- T = unknown
Parameters
- payload: string
Returns T
- Defined in src/serializer/Serializer.ts:113

serialize

serialize<T>(value: T, context?: SerializationContext): string
Serialize an arbitrary value into a JSON string.
Type Parameters
- T
Parameters
- value: T
- Optionalcontext: SerializationContext
Returns string
- Defined in src/serializer/Serializer.ts:120

stringify

stringify<T>(value: T): string
Alias of serialize() to match the historical tunnel serializer surface.
Type Parameters
- T
Parameters
- value: T
Returns string
- Defined in src/serializer/Serializer.ts:96