stash-it-adapter-clientstorage

Client storage for stash-it. You can use either localStorage or sessionStorage.

It's build in ES6 for modern browsers. If you need to run it in older ones, you will have to transpile it. See .babelrc file for more details.

Installation

npm i stash-it-adapter-clientstorage --save

Usage

Mind that you have to run this in browser environment, where you have access to localStorage or sessionStorage.

import { createCache } from 'stash-it';
import createClientStorageAdapter from 'stash-it-adapter-clientstorage';

const adapter = createClientStorageAdapter({ storage: window.localStorage });
const cache = createCache(adapter);

And that's it. You are ready to go.

The only configuration you need to provide is storage - a reference to localStorage or sessionStorage

For available methods, check adapters API section (all adapters have the same API).

Heads-up!

For adapters used in the same browser for the same domain, any instance of cache will have access to all items stored in used storage, regardless of which cache instance was used:

// file1.js - executed BEFORE
import { createCache } from 'stash-it';
import createClientStorageAdapter from 'stash-it-adapter-clientstorage';

const adapter = createClientStorageAdapter({ storage: window.localStorage });
const cache1 = createCache(adapter);

cache1.setItem('key', 'value');


// file2.js - executed AFTER
import { createCache } from 'stash-it';
import createClientStorageAdapter from 'stash-it-adapter-clientstorage';

const adapter = createClientStorageAdapter({ storage: window.localStorage });
const cache2 = createCache(adapter);

cache2.hasItem('key'); // true

And that goes for all of the methods.

How to bypass this (if needed)?

The suggested way is to use a prefix / suffix plugin.