Class Serializer

Index

Constructors

Methods

addType deserialize deserializeValue isBoundedQuantifier isQuantifierAt isQuantifierChar isRegExpPatternSafe isSerializedTypeRecord mergePlaceholder parse resolveReference serialize stringify toNodeRecord

Constructors

constructor

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

Methods

addType

addType<TInstance, TSerialized>(typeDef): 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:178
addType<TJson, TInstance>(name, factory): void
Type Parameters
- TJson = unknown
- TInstance = unknown
Parameters
- name: string
- factory: ((json: TJson) => TInstance)
  - - (json): TInstance
    - Parameters
      json: TJson
      Returns TInstance
Returns void
- Defined in src/serializer/Serializer.ts:181

deserialize

deserialize<T>(payload): 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:153

deserializeValue

deserializeValue(value, context, depth?): unknown
Internal
- Exposed for test compatibility
Parameters
- value: SerializedValue
- context: DeserializationContext
- depth: number = 0
Returns unknown
- Defined in src/serializer/Serializer.ts:251

`Readonly`isBoundedQuantifier

isBoundedQuantifier(pattern, index): boolean
Internal
- Exposed for testing bounded quantifier detection
Parameters
- pattern: string
- index: number
Returns boolean
- Defined in src/serializer/Serializer.ts:231

`Readonly`isQuantifierAt

isQuantifierAt(pattern, index): boolean
Internal
- Exposed for testing quantifier detection
Parameters
- pattern: string
- index: number
Returns boolean
- Defined in src/serializer/Serializer.ts:208

`Readonly`isQuantifierChar

isQuantifierChar(char, pattern, index): boolean
Internal
- Exposed for testing quantifier character detection
Parameters
- char: string
- pattern: string
- index: number
Returns boolean
- Defined in src/serializer/Serializer.ts:219

`Readonly`isRegExpPatternSafe

isRegExpPatternSafe(pattern): boolean
Internal
- Exposed for testing RegExp safety validation
Parameters
- pattern: string
Returns boolean
- Defined in src/serializer/Serializer.ts:199

isSerializedTypeRecord

isSerializedTypeRecord(value): value is {
__type: string;
value: unknown;
}
Internal
- Exposed for test compatibility
Parameters
- value: unknown
Returns value is {
__type: string;
value: unknown;
}
- Defined in src/serializer/Serializer.ts:280

mergePlaceholder

mergePlaceholder(placeholder, result): unknown
Internal
- Exposed for test compatibility
Parameters
- placeholder: unknown
- result: unknown
Returns unknown
- Defined in src/serializer/Serializer.ts:273

parse

parse<T>(payload): 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:115

resolveReference

resolveReference(id, context, depth?): unknown
Internal
- Exposed for test compatibility
Parameters
- id: string
- context: DeserializationContext
- depth: number = 0
Returns unknown
- Defined in src/serializer/Serializer.ts:262

serialize

serialize<T>(value, context?): 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:122

stringify

stringify<T>(value): 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:98

toNodeRecord

toNodeRecord(nodes): Record<string, SerializedNode>
Internal
- Exposed for test compatibility
Parameters
- nodes: Record<string, SerializedNode>
Returns Record<string, SerializedNode>
- Defined in src/serializer/Serializer.ts:242

Class Serializer

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Serializer

Methods

addType

Type Parameters

Parameters

Returns void

Type Parameters

Parameters

Parameters

Returns TInstance

Returns void

deserialize

Type Parameters

Parameters

Returns T

deserializeValue

Parameters

Returns unknown

ReadonlyisBoundedQuantifier

Parameters

Returns boolean

ReadonlyisQuantifierAt

Parameters

Returns boolean

ReadonlyisQuantifierChar

Parameters

Returns boolean

ReadonlyisRegExpPatternSafe

Parameters

Returns boolean

isSerializedTypeRecord

Parameters

Returns value is { __type: string; value: unknown; }

mergePlaceholder

Parameters

Returns unknown

parse

Type Parameters

Parameters

Returns T

resolveReference

Parameters

Returns unknown

serialize

Type Parameters

Parameters

Returns string

stringify

Type Parameters

Parameters

Returns string

toNodeRecord

Parameters

Returns Record<string, SerializedNode>

Settings

On This Page

`Readonly`isBoundedQuantifier

`Readonly`isQuantifierAt

`Readonly`isQuantifierChar

`Readonly`isRegExpPatternSafe

Returns value is {
__type: string;
value: unknown;
}