Skip to content
Source
Sign inSign up
TanStack/db
Open History to see the last commit

LocalStorageCollectionUtils.md

83 lines2.0 KB

1---
2id: LocalStorageCollectionUtils
3title: LocalStorageCollectionUtils
4---
5​
6Defined in: [packages/db/src/local-storage.ts:156](https://github.com/TanStack/db/blob/main/packages/db/src/local-storage.ts#L156)
7​
8LocalStorage collection utilities type
9​
10## Extends
11​
12- [`UtilsRecord`](../type-aliases/UtilsRecord.md)
13​
14## Indexable
15​
16```ts
17[key: string]: any
18```
19​
20## Properties
21​
22### acceptMutations()
23​
24```ts
25acceptMutations: (transaction) => Promise<void>;
26```
27​
28Defined in: [packages/db/src/local-storage.ts:179](https://github.com/TanStack/db/blob/main/packages/db/src/local-storage.ts#L179)
29​
30Accepts this Collection's manual mutations in write order and persists
31them to localStorage. Call it inside the transaction's mutationFn. The
32transaction's persistence receipt waits for this work even if the caller
33does not await the returned Promise. Await it when later mutationFn work
34depends on the storage write.
35​
36#### Parameters
37​
38##### transaction
39​
40The transaction containing mutations to accept
41​
42###### mutations
43​
44[`PendingMutation`](PendingMutation.md)\<`Record`\<`string`, `unknown`\>, [`OperationType`](../type-aliases/OperationType.md), [`Collection`](Collection.md)\<`Record`\<`string`, `unknown`\>, `any`, `any`, `any`, `any`\>\>[]
45​
46#### Returns
47​
48`Promise`\<`void`\>
49​
50#### Example
51​
52```ts
53const localSettings = createCollection(localStorageCollectionOptions({...}))
54​
55const tx = createTransaction({
56 mutationFn: async ({ transaction }) => {
57 // Make API call first
58 await api.save(...)
59 // Then persist local-storage mutations after success
60 await localSettings.utils.acceptMutations(transaction)
61 }
62})
63```
64​
65***
66​
67### clearStorage
68​
69```ts
70clearStorage: ClearStorageFn;
71```
72​
73Defined in: [packages/db/src/local-storage.ts:157](https://github.com/TanStack/db/blob/main/packages/db/src/local-storage.ts#L157)
74​
75***
76​
77### getStorageSize
78​
79```ts
80getStorageSize: GetStorageSizeFn;
81```
82​
83Defined in: [packages/db/src/local-storage.ts:158](https://github.com/TanStack/db/blob/main/packages/db/src/local-storage.ts#L158)