BinarySerializationRegistry

BinarySerializationRegistry

Contains serializers for various data types as well as data upgraders which enable support for serialization format changes

Kind: global class
Author: Alex Goldring
Copyright: Company Named Limited (c) 2025

• BinarySerializationRegistry
  • .isBinarySerializationRegistry : boolean
  • .registerAdapters(adapters)
  • .registerAdapter(adapter, [className]) ⇒ boolean
  • .removeAdapter(className) ⇒ BinaryClassSerializationAdapter | undefined
  • .getAdapter(className) ⇒ BinaryClassSerializationAdapter | undefined
  • .registerUpgrader(className, upgrader) ⇒ boolean
  • .getUpgradersChain(className, startVersion, goalVersion) ⇒ Array.<BinaryClassUpgrader> | null

binarySerializationRegistry.isBinarySerializationRegistry : boolean

Kind: instance property of BinarySerializationRegistry
Read only: true

binarySerializationRegistry.registerAdapters(adapters)

Kind: instance method of BinarySerializationRegistry

Param	Type
adapters	Array.<BinaryClassSerializationAdapter>

binarySerializationRegistry.registerAdapter(adapter, [className]) ⇒ boolean

Kind: instance method of BinarySerializationRegistry
Returns: boolean - true if added, false if adapter already existed
Throws:

• Error if className could not be inferred

Param	Type	Description
adapter	BinaryClassSerializationAdapter
[className]	string	if not specified, will be taken from the BinaryClassSerializationAdapter.klass.typeName

binarySerializationRegistry.removeAdapter(className) ⇒ BinaryClassSerializationAdapter | undefined

Kind: instance method of BinarySerializationRegistry

Param	Type
className	string

binarySerializationRegistry.getAdapter(className) ⇒ BinaryClassSerializationAdapter | undefined

Kind: instance method of BinarySerializationRegistry

Param	Type
className	string

binarySerializationRegistry.registerUpgrader(className, upgrader) ⇒ boolean

Kind: instance method of BinarySerializationRegistry
Returns: boolean - true iff added, false if already exists

Param	Type
className	string
upgrader	BinaryClassUpgrader

binarySerializationRegistry.getUpgradersChain(className, startVersion, goalVersion) ⇒ Array.<BinaryClassUpgrader> | null

Kind: instance method of BinarySerializationRegistry
Returns: Array.<BinaryClassUpgrader> | null - sequential shortest chain of upgraders or null if no valid chain exists

Param	Type
className	string
startVersion	number
goalVersion	number