-
Notifications
You must be signed in to change notification settings - Fork 4
/
index.ts
122 lines (105 loc) · 2.78 KB
/
index.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
/**
* Thin wrapper around idb to use as redux-persist storage using single object store for all data
* @see https://github.com/jakearchibald/idb
* Must implement methods:
* - getItem(key)
* - setItem(key, item)
* - removeItem(key)
* - getAllKeys() required for Redux Persit v4
*/
import { openDb, UpgradeDB, ObjectStore } from 'idb'
export default function createIdbStorage(
definedOptions: {
name?: string
storeName?: string
version?: number
upgradeCallback?: (upgradeDB: UpgradeDB) => ObjectStore<any, string>
} = {}
) {
/** @var {Object} */
const options = {
/** Database name */
name: 'keyval-store',
/** Store name */
storeName: 'keyval',
/** Database version */
version: 1,
/** Upgrade callback. Useful when for example switching storeName */
upgradeCallback: (upgradeDb: UpgradeDB) =>
upgradeDb.createObjectStore(options.storeName),
/** Custom options */
...definedOptions,
}
/** @var {Promise} */
const dbPromise = openDb(
options.name,
options.version,
options.upgradeCallback
)
return {
/**
* Get
* @param {string} key
* @return {Promise}
*/
async getItem(key: string): Promise<any> {
const db = await dbPromise
const tx = db.transaction(options.storeName)
return tx.objectStore(options.storeName).get(key)
},
/**
* Set
* @param {string} key
* @param {any} item
* @return {Promise}
*/
async setItem(
key: string,
item: any
): Promise<void> {
const db = await dbPromise
const tx = db.transaction(options.storeName, 'readwrite')
tx.objectStore(options.storeName).put(item, key)
return tx.complete
},
/**
* Remove
* @param {string} key
* @return {Promise}
*/
async removeItem(key: string): Promise<void> {
const db = await dbPromise
const tx = db.transaction(options.storeName, 'readwrite')
tx.objectStore(options.storeName).delete(key)
return tx.complete
},
/**
* Get all keys
* @return {Promise}
*/
async getAllKeys(): Promise<string[]> {
const db = await dbPromise
const tx = db.transaction(options.storeName)
return tx.objectStore(options.storeName).getAllKeys()
},
/**
* Get all data
* @return {Promise}
*/
async getAll(): Promise<any[]> {
const db = await dbPromise
const tx = db.transaction(options.storeName)
return tx.objectStore(options.storeName).getAll()
},
/**
* Clear storage
* @return {Promise}
*/
async clear(): Promise<void> {
const db = await dbPromise
const tx = db.transaction(options.storeName, 'readwrite')
tx.objectStore(options.storeName).clear()
return tx.complete
},
}
}