Skip to content
Browser Cache API key/value database with +50MB storage capacity, expiration and JSON object data-type support.
Branch: master
Clone or download
Latest commit 1015932 Jun 5, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
dist
src
LICENSE
README.md
cache-api-keyval.ts
package.json size reduction Nov 6, 2018
rollup.config.js description Nov 19, 2018

README.md

Version npm version

Cache API Key/Value Store

Fast and tiny key/value store with +50MB storage capacity in most browsers, expiration and JSON object data-type support.

Cache API is currently available in Chrome >= 40, Firefox >=39 and Opera >= 27.

Safari and Edge recently introduced support for it.

Info by Google: https://developers.google.com/web/fundamentals/instant-and-offline/web-storage/cache-api

Usage

as <script>

<script src="dist/cache-api-keyval-iife.js"></script>
// set JSON object data
CacheApiDB.set('key', { json: 'object' }); 

// set text data with expiration in 24 hours
CacheApiDB.set('key2', 'string', 86400); 

// get data from cache
CacheApiDB.get('key').then(function(json) {
    console.log('json object', json);
});

// delete key from database
CacheApiDB.del('key2'); 

// clear database
CacheApiDB.clear();

// prune expired cache entries
CacheApiDB.prune();

set:

import { set } from 'cache-api-keyval';

set('hello', 'world');
set('foo', 'bar', 3600); // expire in 1 hour

The data is stored in JSON format and supports big data.

All methods return promises:

import { set } from 'cache-api-keyval';

set('hello', 'world')
  .then(() => console.log('It worked!'))
  .catch(err => console.log('It failed!', err));

get:

import { get } from 'cache-api-keyval';

// logs: "world"
get('hello').then(val => console.log(val));

If there is no 'hello' key, then val will be undefined.

keys:

import { keys } from 'cache-api-keyval';

// logs: ["hello", "foo"]
keys().then(keys => console.log(keys));

del:

import { del } from 'cache-api-keyval';

del('hello');

clear:

import { clear } from 'cache-api-keyval';

clear();

prune:

import { prune } from 'cache-api-keyval';

prune();

The prune method clears all expired keys.

Custom stores:

By default, the methods above use a default keyval store. You can create your own store, and pass it as an additional parameter to any of the above methods:

import { get, set } from 'cache-api-keyval';

set('foo', 'bar', 'custom-store');
get('foo', 'custom-store');

That's it!

With thanks to idb-keyval. The v2.0.0 code structure has been copied from idb-keyval.

Installing

Via npm + webpack/rollup

npm install --save cache-api-keyval

Now you can require/import cache-api-keyval:

import { get, set } from 'cache-api-keyval';

Via <script>

  • dist/cache-api-keyval.mjs is a valid JS module.
  • dist/cache-api-keyval-iife.js can be used in browsers that don't support modules. CacheApiDB is created as a global.
  • dist/cache-api-keyval-iife.min.js As above, but minified.
You can’t perform that action at this time.