Class Serializer

Serialization primitives used by HTTP transport, async context exchange, and custom codecs.

Index

Constructors

Methods

addType deserialize parse serialize stringify Field

Constructors

constructor

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

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:296

deserialize

deserialize<TSchemaParsed>(
payload: string,
options: { schema: SerializerSchemaLike<TSchemaParsed> },
): TSchemaParsed
Deserialize a JSON string back to its original value.
Type Parameters
- TSchemaParsed
Parameters
- payload: string
- options: { schema: SerializerSchemaLike<TSchemaParsed> }
Returns TSchemaParsed
- Defined in src/serializer/Serializer.ts:256
deserialize<T = unknown>(
payload: string,
options?: SerializerDeserializeOptions,
): T
Deserialize a JSON string back to its original value.
Type Parameters
- T = unknown
Parameters
- payload: string
- Optionaloptions: SerializerDeserializeOptions
Returns T
- Defined in src/serializer/Serializer.ts:260

parse

parse<TSchemaParsed>(
payload: string,
options: { schema: SerializerSchemaLike<TSchemaParsed> },
): TSchemaParsed
Alias of deserialize() to match the historical remote-lane serializer surface.
Type Parameters
- TSchemaParsed
Parameters
- payload: string
- options: { schema: SerializerSchemaLike<TSchemaParsed> }
Returns TSchemaParsed
- Defined in src/serializer/Serializer.ts:201
parse<T = unknown>(payload: string, options?: SerializerDeserializeOptions): T
Alias of deserialize() to match the historical remote-lane serializer surface.
Type Parameters
- T = unknown
Parameters
- payload: string
- Optionaloptions: SerializerDeserializeOptions
Returns T
- Defined in src/serializer/Serializer.ts:205

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:219

stringify

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

`Static`Field

Field(options?: SerializerFieldOptions): SerializerFieldDecorator
Parameters
- options: SerializerFieldOptions = {}
Returns SerializerFieldDecorator
- Defined in src/serializer/Serializer.ts:127