v2.0.0

Author: optimalisatie

Gruntfile.js

@@ -8,85 +8,110 @@ Cache API is currently available in Chrome >= 40, Firefox >=39 and Opera >= 27.
 
 Safari and Edge recently introduced support for it.
 
-# Install
+Info by Google: https://developers.google.com/web/fundamentals/instant-and-offline/web-storage/cache-api
 
+## Usage
+
+
+### set:
+
+```js
+import { set } from 'cache-api-keyval';
+
+set('hello', 'world');
+set('foo', 'bar', 3600); // expire in 1 hour
 ```
-npm install --save cache-api-keyval
+
+The data is stored in JSON format and supports big data.
+
+All methods return promises:
+
+```js
+import { set } from 'cache-api-keyval';
+
+set('hello', 'world')
+  .then(() => console.log('It worked!'))
+  .catch(err => console.log('It failed!', err));
 ```
 
-# Use
+### get:
 
-```html
-<script src="/cache-api-keyval-full.js"></script>
-<script>
+```js
+import { get } from 'cache-api-keyval';
 
-// load database
-var db = new CacheApiDB('my-store', { namespace: 'optional' });
+// logs: "world"
+get('hello').then(val => console.log(val));
+```
 
-// set JSON object data
-db.set('key', { json: 'object' }); 
+If there is no 'hello' key, then `val` will be `undefined`.
 
-// set text data with expiration in 24 hours
-db.set('key2', 'string', 86400); 
+### keys:
 
-// get data from cache
-db.get('key').then(function(json) {
-    console.log('json object', json);
-});
+```js
+import { keys } from 'cache-api-keyval';
 
-// delete key from database
-db.del('key2'); 
+// logs: ["hello", "foo"]
+keys().then(keys => console.log(keys));
+```
 
-// prune expired cache entries
-db.prune();
+### del:
 
-// if no fallback is provided, all methods will reject and the constructor will contain `no` with integer 1.
-if (db.no) {
+```js
+import { del } from 'cache-api-keyval';
 
-    // Cache API is not supported by the browser
-    
-}
+del('hello');
+```
+
+### clear:
+
+```js
+import { clear } from 'cache-api-keyval';
 
-// optional: wait for async browser check to complete
-// the test checks if Cache API is blocked by privacy or cookie settings
-// when blocked, the fallback storage is loaded
-onCacheApiDB(function() {
+clear();
+```
+
+### prune:
 
-    /* initiate database with certain availability */
+```js
+import { prune } from 'cache-api-keyval';
 
-});
-</script>
+prune();
 ```
 
-## Fallback storage
+The prune method clears all expired keys.
+
+### Custom stores:
 
-To enable a fallback storage for browsers that do not yet support Cache API, you can define a constructor on global variable `CacheApiDBFallback`. The constructor needs to provide 4 methods: `set`, `get`, `del` and `prune`.
+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:
 
 ```js
-window.CacheApiDBFallback = function(store, options) {
-    this.get = function(key) { /* return key from store */ }
-    this.set = function(key,data,expire) { /* set key in store */ }
-    this.del = function(key) { /* delete key from store */ }
-    this.prune = function() { /* cleanup database */ }
-};
+import { get, set } from 'cache-api-keyval';
+
+set('foo', 'bar', 'custom-store');
+get('foo', 'custom-store');
 ```
 
-## Tinier
+That's it!
+
+With thanks to [idb-keyval](https://github.com/jakearchibald/idb-keyval). The `v2.0.0` code structure has been copied from `idb-keyval`.
 
-The complete library provides a fallback mechanism, a check to detect if Cache API is blocked by browser privacy settings and cache expire functionality. While at `871 bytes` compressed it is small, some users may prefer just the `key/val` part with optional expire functionality.
 
-[cache-api-keyval-no-fallback.js](https://github.com/optimalisatie/Cache-API-Key-Value-Store/blob/master/src/cache-api-keyval-no-fallback.js) is a stripped version without error reporting and fallback mechanism with a size of `688 bytes`. [cache-api-keyval-no-fallback-expire.js](https://github.com/optimalisatie/Cache-API-Key-Value-Store/blob/master/src/cache-api-keyval-no-fallback-expire.js) is further stripped of expire functionality for a compressed size of `461 bytes`.
+## Installing
 
+### Via npm + webpack/rollup
 
-```html
-<script src="/cache-api-keyval-no-fallback-expire.js"></script>
-<script>
+```sh
+npm install --save cache-api-keyval
+```
 
-// check if Cache API is available
-if ("caches" in window) {
+Now you can require/import `cache-api-keyval`:
+
+```js
+import { get, set } from 'cache-api-keyval';
+```
 
-    // load database
-    var db = new CacheApiDB('my-store', { namespace: 'optional' });
+### 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.