createBindingPropsMigrationSequence • tldraw Docs

Creates a migration sequence for binding properties. This is a pass-through function that validates and returns the provided migrations.

function createBindingPropsMigrationSequence(
  migrations: TLPropsMigrations
): TLPropsMigrations

Example

// Define migrations for custom binding properties
const myBindingMigrations = createBindingPropsMigrationSequence({
  sequence: [
    {
      id: 'com.myapp.binding.custom/1.0.0',
      up: (props) => ({ ...props, newProperty: 'default' }),
      down: ({ newProperty, ...props }) => props,
    },
  ],
})

Parameters

Name	Description
`migrations`	`TLPropsMigrations` The migration sequence for binding properties

Returns

TLPropsMigrations

The validated migration sequence