LocalStorageCollectionUtils

Defined in: packages/db/src/local-storage.ts:156

LocalStorage collection utilities type

Extends

UtilsRecord

Indexable

[key: string]: any

Properties

acceptMutations()

acceptMutations: (transaction) => Promise<void>;

Defined in: packages/db/src/local-storage.ts:179

Accepts this Collection's manual mutations in write order and persists them to localStorage. Call it inside the transaction's mutationFn. The transaction's persistence receipt waits for this work even if the caller does not await the returned Promise. Await it when later mutationFn work depends on the storage write.

Parameters

transaction

The transaction containing mutations to accept

mutations

PendingMutation<Record<string, unknown>, OperationType, Collection<Record<string, unknown>, any, any, any, any>>[]

Returns

Promise<void>

Example

const localSettings = createCollection(localStorageCollectionOptions({...}))

const tx = createTransaction({
  mutationFn: async ({ transaction }) => {
    // Make API call first
    await api.save(...)
    // Then persist local-storage mutations after success
    await localSettings.utils.acceptMutations(transaction)
  }
})