SerializationExtension
Defined in: src/serialization/SerializationExtension.ts:18
Registry that resolves serializers by ID (at decode time) and by message class (at encode time). JSON (id=1) is the built-in fallback; CBOR (id=2) is registered and available but used only when explicitly bound to a class or asked for by ID.
Will graduate to an ExtensionId<SerializationExtension> once the
Extensions mechanism (P1.2) lands — until then it is constructed
directly inside ActorSystem.
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new SerializationExtension():
SerializationExtension
Defined in: src/serialization/SerializationExtension.ts:23
Returns
Section titled “Returns”SerializationExtension
Accessors
Section titled “Accessors”defaultSerializer
Section titled “defaultSerializer”Get Signature
Section titled “Get Signature”get defaultSerializer():
Serializer
Defined in: src/serialization/SerializationExtension.ts:30
The serializer used for values with no explicit class binding. Defaults to JSON.
Returns
Section titled “Returns”Methods
Section titled “Methods”bind()
Section titled “bind()”bind(
cls,serializerId):void
Defined in: src/serialization/SerializationExtension.ts:48
Bind a message class to a specific serializer (by ID).
Parameters
Section titled “Parameters”ClassCtor
serializerId
Section titled “serializerId”number
Returns
Section titled “Returns”void
decode()
Section titled “decode()”decode(
sv):unknown
Defined in: src/serialization/SerializationExtension.ts:104
Decode a SerializedValue using the serializer it names.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”unknown
encode()
Section titled “encode()”encode(
value):SerializedValue
Defined in: src/serialization/SerializationExtension.ts:94
Encode a value using the resolved serializer; returns a tagged SerializedValue.
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”findById()
Section titled “findById()”findById(
id):Serializer<unknown> |undefined
Defined in: src/serialization/SerializationExtension.ts:55
Find a serializer by ID (used by decoders).
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Serializer<unknown> | undefined
findFor()
Section titled “findFor()”findFor(
value):Serializer
Defined in: src/serialization/SerializationExtension.ts:72
Find the appropriate serializer for a value. Lookup order:
- Exact constructor binding (
bind(Foo, 2)). - Walk the prototype chain for a bound ancestor.
- Default (JSON).
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”register()
Section titled “register()”register(
serializer):void
Defined in: src/serialization/SerializationExtension.ts:37
Parameters
Section titled “Parameters”serializer
Section titled “serializer”Returns
Section titled “Returns”void
registeredIds()
Section titled “registeredIds()”registeredIds():
number[]
Defined in: src/serialization/SerializationExtension.ts:110
Snapshot registered serializer IDs — useful for diagnostics.
Returns
Section titled “Returns”number[]
requireById()
Section titled “requireById()”requireById(
id):Serializer
Defined in: src/serialization/SerializationExtension.ts:60
Look up by ID or throw.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”setDefault()
Section titled “setDefault()”setDefault(
serializer):void
Defined in: src/serialization/SerializationExtension.ts:32
Parameters
Section titled “Parameters”serializer
Section titled “serializer”Returns
Section titled “Returns”void