Skip to main content
Version: 1.4.0

Function: defineMigration()

defineMigration<K, TFrom, TTo>(fromSchema, toSchema, migrate): MigrationRule<TFrom, TTo, K>

Defined in: src/Mnemonic/schema-helpers.ts:31

Create a typed migration rule between two key schema versions.

The migrate(...) callback is inferred from the source and target schemas, which keeps migration logic aligned with the registered runtime schemas.

Type Parameters​

Type Parameter
K extends string
TFrom
TTo

Parameters​

ParameterType
fromSchemaKeySchema<TFrom, K>
toSchemaKeySchema<TTo, K>
migrate(value) => TTo

Returns​

MigrationRule<TFrom, TTo, K>