storage.js

Download

Latest

HTML

<script src="https://jc3213.github.io/storagedb.js/storagedb.js"></script>

TamperMonkey

// @require https://jc3213.github.io/storagedb.js/storagedb.js

Syntax

let storage = new StorageDB(dbName, storeName);

• dbName
  • string
  • The name of the database of indexedDB
  • You can't set database that has already been opened
• storeName
  • string
  • The name of the object store in database of indexedDB

Method

• set
• has
• get
• delete
• entries
• keys
• values
• forEach
• clear
• flush

set

storage.set(key, value);

• key
  • string or number
• value
  • string, number, object, array, or blob

has

let result = await storage.has(key);

• result
  • boolean

get

let value = await storage.get(key);

delete

await storage.delete(key);

entries

let entries = await storage.entires();

• entries
  • array

keys

let keys = await storage.keys();

• keys
  • array

values

let values = await storage.values();

• values
  • array
  • If you want to iterate over the values
  • It is recommended to use forEach method instead

forEach

await storage.forEach(
    callback: function
);

• callback
  • function
  • ( item: { key, value } ) => void

clear

await storage.clear();

flush

await storage.flush();

Code Sample

let db = new Storage('sample', 'test');
console.log(await db.set('aaa', 'bbb')); // 'aaa';
console.log(await db.set('ccc', 'ddd')); // 'ccc';
console.log(await db.has('bbb')); // false;
console.log(await db.keys()); // ['aaa', 'ccc'];
console.log(await db.set('aaa', 'eee')); // 'aaa'; overwrite 'aaa' => 'eee';
console.log(await db.values()); // ['eee', 'ddd'];
console.log(await db.delete('aaa')); // undefined; removed 'aaa' => 'eee';
console.log(await db.entries()); // [ {key: 'bbb', value: 'ddd'} ];
console.log(await db.clear()); // undefined; clear all items under database 'sample' -> object store 'test'
console.log(await db.entries()); // [];
console.log(await db.flush()); // true;
console.log(await indexedDB.databases()); // [];