Interface SerifyOptions<M>

Options defining serifiable types and related callback functions.

interface SerifyOptions<M extends SerifiableTypeMap> {
serifyKey: SerializablePrimitive;
types: { [T in string | number | symbol]: SerifyOptionTypeCallbacks<M[T]> };
}

Type Parameters

M extends SerifiableTypeMap
The SerifiableTypeMap describing supported types.

Index

Properties

serifyKey types

Properties

serifyKey

serifyKey: SerializablePrimitive

Marker value written to every serified value. Change it to disambiguate serified values from data that happens to share their shape.

types

types: { [T in string | number | symbol]: SerifyOptionTypeCallbacks<M[T]> }

Serifier/deserifier callbacks, keyed by type identifier.