SchemaRegistry
Defined in: src/persistence/migration/SchemaRegistry.ts:85
Public API of any schema registry impl.
Methods
Section titled “Methods”eventAdapter()
Section titled “eventAdapter()”eventAdapter<
E>(manifest):EventAdapter<E,unknown>
Defined in: src/persistence/migration/SchemaRegistry.ts:112
Build an EventAdapter that writes at the latest registered
version of manifest and reads any registered version by
chaining upcasters forward.
Type Parameters
Section titled “Type Parameters”E
Parameters
Section titled “Parameters”manifest
Section titled “manifest”string
Returns
Section titled “Returns”EventAdapter<E, unknown>
get(
manifest,version):SchemaDescriptor|undefined
Defined in: src/persistence/migration/SchemaRegistry.ts:99
Look up the registration for (manifest, version), if any.
Parameters
Section titled “Parameters”manifest
Section titled “manifest”string
version
Section titled “version”number
Returns
Section titled “Returns”SchemaDescriptor | undefined
latestVersion()
Section titled “latestVersion()”latestVersion(
manifest):number|undefined
Defined in: src/persistence/migration/SchemaRegistry.ts:102
Highest registered version for manifest, or undefined if unknown.
Parameters
Section titled “Parameters”manifest
Section titled “manifest”string
Returns
Section titled “Returns”number | undefined
list()
Section titled “list()”list(): readonly
SchemaDescriptor[]
Defined in: src/persistence/migration/SchemaRegistry.ts:105
Snapshot of every registration — primarily for debugging / introspection.
Returns
Section titled “Returns”readonly SchemaDescriptor[]
register()
Section titled “register()”register<
Wire,Upcasted>(manifest,version,registration):void
Defined in: src/persistence/migration/SchemaRegistry.ts:93
Add or replace the registration for (manifest, version).
Runs the configured compat check; throws on incompatibility.
Re-registering the same (manifest, version) overwrites — the
registry doesn’t enforce immutability, that’s an operator
concern.
Type Parameters
Section titled “Type Parameters”Wire = unknown
Upcasted
Section titled “Upcasted”Upcasted = unknown
Parameters
Section titled “Parameters”manifest
Section titled “manifest”string
version
Section titled “version”number
registration
Section titled “registration”SchemaRegistration<Wire, Upcasted>
Returns
Section titled “Returns”void
snapshotAdapter()
Section titled “snapshotAdapter()”snapshotAdapter<
S>(manifest):SnapshotAdapter<S,unknown>
Defined in: src/persistence/migration/SchemaRegistry.ts:115
Same as eventAdapter but typed for snapshot/state actors.
Type Parameters
Section titled “Type Parameters”S
Parameters
Section titled “Parameters”manifest
Section titled “manifest”string
Returns
Section titled “Returns”SnapshotAdapter<S, unknown>