StoreSchema • tldraw Docs

Table of contents

migrations
sortedMigrations
types
Properties
Methods

class StoreSchema<R extends UnknownRecord, P = unknown> {}

Properties

migrations

readonly

readonly migrations: Record<string, MigrationSequence>

sortedMigrations

readonly

readonly sortedMigrations: readonly Migration[]

types

readonly

readonly types: {
  [Record in R as Record['typeName']]: RecordType<R, any>
}

Methods

create()

static

static create<R extends UnknownRecord, P = unknown>(
  types: {
    [TypeName in R['typeName']]: {
      createId: any
    }
  },
  options?: StoreSchemaOptions<R, P>
): StoreSchema<R, P>

Parameters

Name	Description
`types`	`{ [TypeName in R['typeName']]: { createId: any } }`
`options`	`StoreSchemaOptions<R, P>`

Returns

StoreSchema<R, P>

getMigrationsSince()

getMigrationsSince(
  persistedSchema: SerializedSchema
): Result<Migration[], string>

Parameters

Name	Description
`persistedSchema`	`SerializedSchema`

Returns

Result<Migration[], string>

migratePersistedRecord()

migratePersistedRecord(
  record: R,
  persistedSchema: SerializedSchema,
  direction?: 'down' | 'up'
): MigrationResult<R>

Parameters

Name	Description
`record`	`R`
`persistedSchema`	`SerializedSchema`
`direction`	`'down' \| 'up'`

Returns

MigrationResult<R>

migrateStoreSnapshot()

migrateStoreSnapshot(
  snapshot: StoreSnapshot<R>
): MigrationResult<SerializedStore<R>>

Parameters

Name	Description
`snapshot`	`StoreSnapshot<R>`

Returns

MigrationResult<SerializedStore<R>>

serialize()

serialize(): SerializedSchemaV2

serializeEarliestVersion()

Deprecated: This is only here for legacy reasons, don't use it unless you have david's blessing!

serializeEarliestVersion(): SerializedSchema

validateRecord()

validateRecord(
  store: Store<R>,
  record: R,
  phase: 'createRecord' | 'initialize' | 'tests' | 'updateRecord',
  recordBefore: null | R
): R

Parameters

Name	Description
`store`	`Store<R>`
`record`	`R`
`phase`	`\| 'createRecord' \| 'initialize' \| 'tests' \| 'updateRecord'`
`recordBefore`	`null \| R`