StoreSchema

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

Properties

readonly migrations: Record<string, MigrationSequence>

readonly sortedMigrations: readonly Migration[]

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

Methods

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

{
  [TypeName in R['typeName']]: {
    createId: any
  }
}

StoreSchemaOptions<R, P>

StoreSchema<R, P>

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

SerializedSchema

Result<Migration[], string>

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

R

SerializedSchema

'down' | 'up'

MigrationResult<R>

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

StoreSnapshot<R>

MigrationResult<SerializedStore<R>>

serialize(): SerializedSchemaV2

serializeEarliestVersion(): SerializedSchema

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

Store<R>

R

  | 'createRecord'
  | 'initialize'
  | 'tests'
  | 'updateRecord'

null | R

R