Skip to main content
Version: 1.2.0-beta1

Interface: CreateSchemaRegistryOptions

Defined in: src/Mnemonic/types.ts:563

Input options for createSchemaRegistry.

Use this helper when your registry contents are known up front and do not need runtime mutation. The returned registry is immutable and optimized for the common "default" / "strict" setup.

For most apps, this should be your default entry point for schema-managed persistence. Implement SchemaRegistry manually only when you need custom lookup behavior or runtime schema registration beyond autoschema mode.

Properties

migrations?

optional migrations: readonly MigrationRule<unknown, unknown, string>[]

Defined in: src/Mnemonic/types.ts:580

Migration rules to index by key and version edge.

Write-time normalizers (fromVersion === toVersion) are indexed separately from read-time migration edges. Ambiguous outgoing edges, backward migrations, and duplicate write normalizers are rejected up front with SchemaError("MIGRATION_GRAPH_INVALID").


schemas?

optional schemas: readonly KeySchema<unknown, string, JsonSchema>[]

Defined in: src/Mnemonic/types.ts:570

Versioned schemas to index by key and version.

Duplicate key + version pairs are rejected up front with SchemaError("SCHEMA_REGISTRATION_CONFLICT").