This is a super-simple-small promise-based keyval store implemented with IndexedDB, largely based on async-storage by Mozilla.
localForage offers similar functionality, but supports older browsers with broken/absent IDB implementations. Because of that, it's 7.4k, whereas idb-keyval is < 600 bytes. Also, it's tree-shaking friendly, so you'll probably end up using fewer than 500 bytes. Pick whichever works best for you!
This is only a keyval store. If you need to do more complex things like iteration & indexing, check out IDB on NPM (a little heavier at 1.7k). The first example in its README is how to recreate this library.
Since this is IDB-backed, you can store anything structured-clonable (numbers, arrays, objects, dates, blobs etc).
All methods return promises:
;// logs: "world";
If there is no 'hello' key, then
val will be
;// logs: ["hello", "foo"];
By default, the methods above use an IndexedDB database named
keyval-store and an object store named
keyval. You can create your own store, and pass it as an additional parameter to any of the above methods:
;const customStore = 'custom-db-name' 'custom-store-name';;
Via npm + webpack/rollup
npm install idb-keyval
Now you can require/import
dist/idb-keyval.mjsis a valid JS module.
dist/idb-keyval-iife.jscan be used in browsers that don't support modules.
idbKeyvalis created as a global.
dist/idb-keyval-iife.min.jsAs above, but minified.
dist/idb-keyval-iife-compat.min.jsAs above, but works in older browsers such as IE 10.
dist/idb-keyval-amd.jsis an AMD module.
dist/idb-keyval-amd.min.jsAs above, but minified.
These built versions are also available on jsDelivr, e.g.:
<!-- Or in modern browsers: -->
Updating from 2.x
2.x exported an object with methods:
// This no longer works in 3.x;idbKeyval;
Whereas in 3.x you import the methods directly:
This is better for minification, and allows tree shaking.