Open History to see the last commit
Interface: LocalStorageCollectionUtils#
Defined in: packages/db/src/local-storage.ts:100
LocalStorage collection utilities type
Extends#
Indexable#
[key: string]: any
Properties#
acceptMutations()#
acceptMutations: (transaction) => void;
Defined in: packages/db/src/local-storage.ts:120
Accepts mutations from a transaction that belong to this collection and persists them to localStorage. This should be called in your transaction's mutationFn to persist local-storage data.
Parameters#
transaction#
The transaction containing mutations to accept
mutations#
PendingMutation<Record<string, unknown>, OperationType, Collection<Record<string, unknown>, any, any, any, any>>[]
Returns#
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
localSettings.utils.acceptMutations(transaction)
}
})
clearStorage#
clearStorage: ClearStorageFn;
Defined in: packages/db/src/local-storage.ts:101
getStorageSize#
getStorageSize: GetStorageSizeFn;
Defined in: packages/db/src/local-storage.ts:102