Skip to content
actor-ts

SchemaRegistration

Defined in: src/persistence/migration/SchemaRegistry.ts:60

What a single registered version contributes to the registry.

Extended by

Section titled “Extended by”

Type Parameters

Section titled “Type Parameters”

Wire

Section titled “Wire”

Wire = unknown

Upcasted

Section titled “Upcasted”

Upcasted = unknown

Properties

Section titled “Properties”

codec

Section titled “codec”

readonly codec: Codec<Wire>

Defined in: src/persistence/migration/SchemaRegistry.ts:62

Codec used to validate / shape payloads at this version.

compatibility?

Section titled “compatibility?”

readonly optional compatibility?: "none" | "backward" | "sample"

Defined in: src/persistence/migration/SchemaRegistry.ts:70

Compatibility-check mode applied at register time. Default 'none'.

sample?

Section titled “sample?”

readonly optional sample?: unknown

Defined in: src/persistence/migration/SchemaRegistry.ts:76

Optional sample value used by 'sample' compat checks — passed through the previous version’s encode → decode → upcast → this version’s encode round-trip. Throws if any step fails.

upcastFromPrev?

Section titled “upcastFromPrev?”

readonly optional upcastFromPrev?: (prev) => Upcasted

Defined in: src/persistence/migration/SchemaRegistry.ts:68

Pure function prevVersionDomain → thisVersionDomain used on the read path to bring data forward. Required for any version

1 if reads from older data are expected to succeed.

Parameters

Section titled “Parameters”
prev
Section titled “prev”

unknown

Returns

Section titled “Returns”

Upcasted