StoreSchema

Public Class

Signature

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

References

BaseRecord

Properties

currentStoreVersion

Public Readonly Property

Signature

get currentStoreVersion(): number

types

Public Readonly Property

Signature

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

References

RecordType

Methods

create()

Public Static Method

Parameters

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

StoreSchemaOptions<R, P>

Returns

StoreSchema<R, P>

References

BaseRecord, StoreSchemaOptions, StoreSchema

migratePersistedRecord()

Public Method

Parameters

R

SerializedSchema

'down' | 'up'

Returns

MigrationResult<R>

References

SerializedSchema, MigrationResult

migrateStoreSnapshot()

Public Method

Parameters

StoreSnapshot<R>

SerializedSchema

Returns

MigrationResult<StoreSnapshot<R>>

References

StoreSnapshot, SerializedSchema, MigrationResult

serialize()

Public Method

Parameters

None

Returns

SerializedSchema

References

SerializedSchema

serializeEarliestVersion()

Public Method

Parameters

None

Returns

SerializedSchema

References

SerializedSchema

validateRecord()

Public Method

Parameters

Store<R>

R

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

null | R

Returns

R

References

Store