SchemaDescriptor
Defined in: src/persistence/migration/SchemaRegistry.ts:79
What a single registered version contributes to the registry.
Extends
Section titled “Extends”Properties
Section titled “Properties”
readonlycodec:Codec<unknown>
Defined in: src/persistence/migration/SchemaRegistry.ts:62
Codec used to validate / shape payloads at this version.
Inherited from
Section titled “Inherited from”compatibility?
Section titled “compatibility?”
readonlyoptionalcompatibility?:"none"|"backward"|"sample"
Defined in: src/persistence/migration/SchemaRegistry.ts:70
Compatibility-check mode applied at register time. Default 'none'.
Inherited from
Section titled “Inherited from”SchemaRegistration.compatibility
manifest
Section titled “manifest”
readonlymanifest:string
Defined in: src/persistence/migration/SchemaRegistry.ts:80
sample?
Section titled “sample?”
readonlyoptionalsample?: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.
Inherited from
Section titled “Inherited from”upcastFromPrev?
Section titled “upcastFromPrev?”
readonlyoptionalupcastFromPrev?: (prev) =>unknown
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”unknown
Returns
Section titled “Returns”unknown
Inherited from
Section titled “Inherited from”SchemaRegistration.upcastFromPrev
version
Section titled “version”
readonlyversion:number
Defined in: src/persistence/migration/SchemaRegistry.ts:81