export function promisifyRequest( request: IDBRequest | IDBTransaction ): Promise { return new Promise((resolve, reject) => { // @ts-ignore - file size hacks request.oncomplete = request.onsuccess = () => resolve(request.result); // @ts-ignore - file size hacks request.onabort = request.onerror = () => reject(request.error); }); } export function createStore(dbName: string, storeName: string): UseStore { const request = indexedDB.open(dbName); request.onupgradeneeded = () => request.result.createObjectStore(storeName); const dbp = promisifyRequest(request); return (txMode, callback) => dbp.then((db) => callback(db.transaction(storeName, txMode).objectStore(storeName)) ); } export type UseStore = ( txMode: IDBTransactionMode, callback: (store: IDBObjectStore) => T | PromiseLike ) => Promise; let defaultGetStoreFunc: UseStore | undefined; function defaultGetStore() { if (!defaultGetStoreFunc) { defaultGetStoreFunc = createStore("keyval-store", "keyval"); } return defaultGetStoreFunc; } /** * Get a value by its key. * * @param key * @param customStore Method to get a custom store. Use with caution (see the docs). */ export function get( key: IDBValidKey, customStore = defaultGetStore() ): Promise { return customStore("readonly", (store) => promisifyRequest(store.get(key))); } /** * Set a value with a key. * * @param key * @param value * @param customStore Method to get a custom store. Use with caution (see the docs). */ export function set( key: IDBValidKey, value: any, customStore = defaultGetStore() ): Promise { return customStore("readwrite", (store) => { store.put(value, key); return promisifyRequest(store.transaction); }); } /** * Set multiple values at once. This is faster than calling set() multiple times. * It's also atomic – if one of the pairs can't be added, none will be added. * * @param entries Array of entries, where each entry is an array of `[key, value]`. * @param customStore Method to get a custom store. Use with caution (see the docs). */ export function setMany( entries: [IDBValidKey, any][], customStore = defaultGetStore() ): Promise { return customStore("readwrite", (store) => { entries.forEach((entry) => store.put(entry[1], entry[0])); return promisifyRequest(store.transaction); }); } /** * Get multiple values by their keys * * @param keys * @param customStore Method to get a custom store. Use with caution (see the docs). */ export function getMany( keys: IDBValidKey[], customStore = defaultGetStore() ): Promise { return customStore("readonly", (store) => Promise.all(keys.map((key) => promisifyRequest(store.get(key)))) ); } /** * Update a value. This lets you see the old value and update it as an atomic operation. * * @param key * @param updater A callback that takes the old value and returns a new value. * @param customStore Method to get a custom store. Use with caution (see the docs). */ export function update( key: IDBValidKey, updater: (oldValue: T | undefined) => T, customStore = defaultGetStore() ): Promise { return customStore( "readwrite", (store) => // Need to create the promise manually. // If I try to chain promises, the transaction closes in browsers // that use a promise polyfill (IE10/11). new Promise((resolve, reject) => { store.get(key).onsuccess = function () { try { store.put(updater(this.result), key); resolve(promisifyRequest(store.transaction)); } catch (err) { reject(err); } }; }) ); } /** * Delete a particular key from the store. * * @param key * @param customStore Method to get a custom store. Use with caution (see the docs). */ export function del( key: IDBValidKey, customStore = defaultGetStore() ): Promise { return customStore("readwrite", (store) => { store.delete(key); return promisifyRequest(store.transaction); }); } /** * Delete multiple keys at once. * * @param keys List of keys to delete. * @param customStore Method to get a custom store. Use with caution (see the docs). */ export function delMany( keys: IDBValidKey[], customStore = defaultGetStore() ): Promise { return customStore("readwrite", (store: IDBObjectStore) => { keys.forEach((key: IDBValidKey) => store.delete(key)); return promisifyRequest(store.transaction); }); } /** * Clear all values in the store. * * @param customStore Method to get a custom store. Use with caution (see the docs). */ export function clear(customStore = defaultGetStore()): Promise { return customStore("readwrite", (store) => { store.clear(); return promisifyRequest(store.transaction); }); } function eachCursor( store: IDBObjectStore, callback: (cursor: IDBCursorWithValue) => void ): Promise { store.openCursor().onsuccess = function () { if (!this.result) return; callback(this.result); this.result.continue(); }; return promisifyRequest(store.transaction); } /** * Get all keys in the store. * * @param customStore Method to get a custom store. Use with caution (see the docs). */ export function keys( customStore = defaultGetStore() ): Promise { return customStore("readonly", (store) => { // Fast path for modern browsers if (store.getAllKeys) { return promisifyRequest( store.getAllKeys() as unknown as IDBRequest ); } const items: KeyType[] = []; return eachCursor(store, (cursor) => items.push(cursor.key as KeyType) ).then(() => items); }); } /** * Get all values in the store. * * @param customStore Method to get a custom store. Use with caution (see the docs). */ export function values(customStore = defaultGetStore()): Promise { return customStore("readonly", (store) => { // Fast path for modern browsers if (store.getAll) { return promisifyRequest(store.getAll() as IDBRequest); } const items: T[] = []; return eachCursor(store, (cursor) => items.push(cursor.value as T)).then( () => items ); }); } /** * Get all entries in the store. Each entry is an array of `[key, value]`. * * @param customStore Method to get a custom store. Use with caution (see the docs). */ export function entries( customStore = defaultGetStore() ): Promise<[KeyType, ValueType][]> { return customStore("readonly", (store) => { // Fast path for modern browsers // (although, hopefully we'll get a simpler path some day) if (store.getAll && store.getAllKeys) { return Promise.all([ promisifyRequest( store.getAllKeys() as unknown as IDBRequest ), promisifyRequest(store.getAll() as IDBRequest), ]).then(([keys, values]) => keys.map((key, i) => [key, values[i]])); } const items: [KeyType, ValueType][] = []; return customStore("readonly", (store) => eachCursor(store, (cursor) => items.push([cursor.key as KeyType, cursor.value]) ).then(() => items) ); }); }