Interface TypeDefinition<TInstance, TSerialized>

Definition for a custom type that can be serialized/deserialized

interface TypeDefinition<TInstance, TSerialized> {
    create?: (() => TInstance);
    deserialize: ((data: TSerialized) => TInstance);
    id: string;
    is: ((obj: unknown) => obj is TInstance);
    serialize: ((obj: TInstance) => TSerialized);
    strategy?: "value" | "ref";
}

Type Parameters

  • TInstance = unknown
  • TSerialized = unknown

Properties

create? deserialize id is serialize strategy?

Properties

Optionalcreate

create?: (() => TInstance)

Optional factory used to create a placeholder during deserialization

deserialize

deserialize: ((data: TSerialized) => TInstance)

Function to deserialize the data back to the original object

id

id: string

Unique identifier for the type

is

is: ((obj: unknown) => obj is TInstance)

Predicate function to check if an object matches this type

serialize

serialize: ((obj: TInstance) => TSerialized)

Function to serialize the object

Optionalstrategy

strategy?: "value" | "ref"

Serialization strategy: 'value' (inline, no identity) or 'ref' (graph node, identity preserved). Default: 'ref'

Settings

Member Visibility

On This Page

Properties