StoreSchema

Public class

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

UnknownRecord

packages/store/src/lib/StoreSchema.ts

Properties

migrations

Public readonly property

readonly migrations: Record<string, MigrationSequence>

MigrationSequence

sortedMigrations

Public readonly property

readonly sortedMigrations: readonly Migration[]

Migration

types

Public readonly property

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

RecordType

Methods

create()

Public static method

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>

UnknownRecord, StoreSchemaOptions, StoreSchema

getMigrationsSince()

Public method

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

SerializedSchema

Result<Migration[], string>

SerializedSchema, Migration

migratePersistedRecord()

Public method

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

R

SerializedSchema

'down' | 'up'

MigrationResult<R>

SerializedSchema, MigrationResult

migrateStoreSnapshot()

Public method

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

StoreSnapshot<R>

MigrationResult<SerializedStore<R>>

StoreSnapshot, MigrationResult, SerializedStore

serialize()

Public method

serialize(): SerializedSchemaV2

SerializedSchemaV2

serializeEarliestVersion()

Public method

serializeEarliestVersion(): SerializedSchema

SerializedSchema

validateRecord()

Public method

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

Store