Store

Public class

A store of records.

class Store<R extends UnknownRecord = UnknownRecord, Props = unknown> {}

UnknownRecord

packages/store/src/lib/Store.ts

Constructor

Public constructor

Constructs a new instance of the Store class

{
  schema: StoreSchema<R, Props>
  initialData?: SerializedStore<R>
  id?: string
  props: Props
}

StoreSchema, SerializedStore

Properties

allRecords

Public property

Get an array of all values in the store.

allRecords: () => R[]

clear

Public property

Removes all records from the store.

clear: () => void

createComputedCache

Public property

Create a computed cache.

createComputedCache: <Result, Record extends R = R>(
  name: string,
  derive: (record: Record) => Result | undefined,
  isEqual?: ((a: Record, b: Record) => boolean) | undefined
) => ComputedCache<Result, Record>

ComputedCache

createSelectedComputedCache

Public property

Create a computed cache from a selector

createSelectedComputedCache: <Selection, Result, Record extends R = R>(
  name: string,
  selector: (record: Record) => Selection | undefined,
  derive: (input: Selection) => Result | undefined
) => ComputedCache<Result, Record>

ComputedCache

get

Public property

Get the value of a store record by its id.

get: <K extends IdOf<R>>(id: K) => RecFromId<K> | undefined

IdOf

has

Public property

Get whether the record store has a id.

has: <K extends IdOf<R>>(id: K) => boolean

IdOf

history

Public readonly property

An atom containing the store's history.

readonly history: Atom<number, RecordsDiff<R>>

RecordsDiff

id

Public readonly property

The random id of the store.

readonly id: string

listen

Public property

Add a new listener to the store.

listen: (
  onHistory: StoreListener<R>,
  filters?: Partial<StoreListenerFilters>
) => () => void

StoreListener

mergeRemoteChanges

Public property

Merge changes from a remote source without triggering listeners.

mergeRemoteChanges: (fn: () => void) => void

onAfterChange

Public property

A callback fired after each record's change.

onAfterChange?: (prev: R, next: R, source: 'remote' | 'user') => void

onAfterCreate

Public property

A callback fired after a record is created. Use this to perform related updates to other records in the store.

onAfterCreate?: (record: R, source: 'remote' | 'user') => void

onAfterDelete

Public property

A callback fired after a record is deleted.

onAfterDelete?: (prev: R, source: 'remote' | 'user') => void

onBeforeChange

Public property

A callback fired before each record's change.

onBeforeChange?: (prev: R, next: R, source: 'remote' | 'user') => R

onBeforeCreate

Public property

A callback fired after each record's change.

onBeforeCreate?: (next: R, source: 'remote' | 'user') => R

onBeforeDelete

Public property

A callback fired before a record is deleted.

onBeforeDelete?: (prev: R, source: 'remote' | 'user') => false | void

props

Public readonly property

readonly props: Props

put

Public property

Add some records to the store. It's an error if they already exist.

put: (records: R[], phaseOverride?: 'initialize') => void

query

Public readonly property

A StoreQueries instance for this store.

readonly query: StoreQueries<R>

remove

Public property

Remove some records from the store via their ids.

remove: (ids: IdOf<R>[]) => void

IdOf

schema

Public readonly property

readonly schema: StoreSchema<R, Props>

StoreSchema

scopedTypes

Public readonly property

readonly scopedTypes: {
  readonly [K in RecordScope]: ReadonlySet<R['typeName']>
}

serialize

Public property

Creates a JSON payload from the record store.

serialize: (scope?: 'all' | RecordScope) => SerializedStore<R>

SerializedStore

unsafeGetWithoutCapture

Public property

Get the value of a store record by its id without updating its epoch.

unsafeGetWithoutCapture: <K extends IdOf<R>>(
  id: K
) => RecFromId<K> | undefined

IdOf

update

Public property

Update a record. To update multiple records at once, use the update method of the TypedStore class.

update: <K extends IdOf<R>>(
  id: K,
  updater: (record: RecFromId<K>) => RecFromId<K>
) => void

IdOf

Methods

applyDiff()

Public method

applyDiff(
  diff: RecordsDiff<R>,
  {
    runCallbacks,
    ignoreEphemeralKeys,
  }?: {
    ignoreEphemeralKeys?: boolean
    runCallbacks?: boolean
  }
): void

RecordsDiff<R>

{
  ignoreEphemeralKeys?: boolean
  runCallbacks?: boolean
}

void

RecordsDiff

extractingChanges()

Public method

Run fn and return a RecordsDiff of the changes that occurred as a result.

extractingChanges(fn: () => void): RecordsDiff<R>

() => void

RecordsDiff<R>

RecordsDiff

filterChangesByScope()

Public method

Filters out non-document changes from a diff. Returns null if there are no changes left.

filterChangesByScope(
  change: RecordsDiff<R>,
  scope: RecordScope
): {
  added: { [K in IdOf<R>]: R }
  removed: { [K in IdOf<R>]: R }
  updated: { [K_1 in IdOf<R>]: [from: R, to: R] }
} | null

RecordsDiff<R>

RecordScope

{
  added: { [K in IdOf<R>]: R }
  removed: { [K in IdOf<R>]: R }
  updated: { [K_1 in IdOf<R>]: [from: R, to: R] }
} | null

RecordsDiff, IdOf

getSnapshot()

Public method

Get a serialized snapshot of the store and its schema.

const snapshot = store.getSnapshot()
store.loadSnapshot(snapshot)

getSnapshot(scope?: 'all' | RecordScope): StoreSnapshot<R>

'all' | RecordScope

StoreSnapshot<R>

StoreSnapshot

loadSnapshot()

Public method

Load a serialized snapshot.

const snapshot = store.getSnapshot()
store.loadSnapshot(snapshot)

loadSnapshot(snapshot: StoreSnapshot<R>): void

StoreSnapshot<R>

void

StoreSnapshot

migrateSnapshot()

Public method

Migrate a serialized snapshot of the store and its schema.

const snapshot = store.getSnapshot()
store.migrateSnapshot(snapshot)

migrateSnapshot(snapshot: StoreSnapshot<R>): StoreSnapshot<R>

StoreSnapshot<R>

StoreSnapshot<R>

StoreSnapshot

validate()

Public method

validate(
  phase: 'createRecord' | 'initialize' | 'tests' | 'updateRecord'
): void

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

void