package
Async IndexedDB based Map
npm install @webreflection/idb-mapGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Tagged topics.
Estimated unpacked size across 1 packages.
17.8 kB
Includes dependencies.
Social Media Photo by delfi de la Rua on Unsplash
An IndexedDB based Map with an asynchronous interface.
An IDBMap instance implements all Map methods or accessors except these are all asynchroonus.
An IDBMap also extends EventTarget too, so dispatchEvent is also available, among others. Handled events are by default abort, close, error and versionchange.
The IDBMap constructor is the only main different API compared to Map:
name suffix as string. The DB will be called 'IDBMap/${name}'. The storage name used for this db will be entries. An empty string is also a valid name but please be aware of naming collisionsoptions object, currently to either override transactions' durability, where its default value is 'default', or to use a different database prefix name which default value is 'IDBMap'type IDBMapOptions = {
durability?: 'strict' | 'relaxed' | 'default';
prefix?: string;
}
class IDBMap extends EventTarget implements Map {
constructor(
name:string,
options:IDBMapOptions = { durability: 'default', prefix: 'IDBMap' }
):IDBMap
// the only extra method not present in Map or EventTarget
close():Promise<void>
}import IDBMap from '@webreflection/idb-map';
// create an async map with a generic storage name
const idbMap = new IDBMap('my-storage-name');
// check any Map property by awaiting it
console.log(await idbMap.size);
console.log(await idbMap.has('nope'));
// optional helpers for buffered data
const encoder = new TextEncoder;
const decoder = new TextDecoder;
// set any IDB compatible value
await idbMap.set('test.txt', 'test value');
console.log(
The idb-map/sync export returns an instance of Map (no EventTarget) with only a sync() extra method that is needed to be awaited on bootstrap or, if many changes are performed, before closing the thread.
Its content and methods are entirely loaded into RAM so it's less efficient in that regard but surely easier to both handle and reason about plus it's definitively faster than the fully async version.
import IDBMapSync from '@webreflection/idb-map/sync';
// create an async map with a generic storage name
const idbMap = new IDBMapSync('my-storage-name');
// await to populate it on bootstrap
await idbMap.sync();
// check any Map property by awaiting it
console.log(idbMap.size);
console.log(idbMap.has('nope'));
// optional helpers for buffered data
const encoder = new TextEncoder;
const decoder = new TextDecoder;
// set any IDB compatible value
idbMap.set('test.txt', 'test value');
There are other projects with a similar goal, most popular or notable is idb-keyval, but ...
.close() asynchronous method to ensure a db has been successfully closedThat's pretty much it; you already know this module and the only different thing is the way an IDBMap is initialized.