SchemaPropsInfo

See source code
Table of contents

Configuration information for a schema type (shape or binding), including its properties, metadata, and migration sequences for data evolution over time.

interface SchemaPropsInfo {}

Example

import { arrowShapeMigrations, arrowShapeProps } from './shapes/TLArrowShape'

const myShapeSchema: SchemaPropsInfo = {
  migrations: arrowShapeMigrations,
  props: arrowShapeProps,
  meta: {
    customField: T.string,
  },
}

Properties

meta

optional

Validation schema for metadata fields. Maps metadata field names to their validators.

meta?: Record<string, StoreValidator<any>>

migrations

optional

Migration sequences for handling data evolution over time. Can be legacy migrations, props-specific migrations, or general migration sequences.


props

optional

Validation schema for the shape or binding properties. Maps property names to their validators.

props?: Record<string, StoreValidator<any>>

Prev
BoxModel
Next
TLArrowBindingProps