persistore

persistore

The Persistore is primary designed to use a very easy API (get, set, remove) to store any string with fallback strategies that apply automatically to each client browser. So if localStorage is not accessible it falls back internally to cookies. And if this would be neither possible, it will just use local variables, which is as persistent as possible in this situation without any backend support.

Some aspects

• TypeScript support included
• coverage of 100% is mandatory
• < 0.85 kB (gzipped) (see bundlephobia)
• any issues will be fixed as soon as possible

Installation

With yarn

npm i --save persistore

Usage

import { Persistore } from 'persistore';

Persistore.set('my-key', '{"here": "comes your data"}');

console.log(Persistore.get('my-key')); // prints: '{"here": "comes your data"}'

Persistore.remove('my-key');

console.log(Persistore.get('my-key')); // prints: undefined

Same is possible for persistence restricted to session lifetime:

import { Persistore } from 'persistore';

Persistore.session.set('my-key', '{"here": "comes your data"}');

console.log(Persistore.session.get('my-key')); // prints: '{"here": "comes your data"}'

Persistore.session.remove('my-key');

console.log(Persistore.session.get('my-key')); // prints: undefined

And additional features to handle cookies is also included:

import { CookieUtil } from 'persistore';

CookieUtil.set('my-key', '{"here": "comes your data"}');

console.log(CookieUtil.get('my-key')); // prints: '{"here": "comes your data"}'

CookieUtil.remove('my-key');

console.log(CookieUtil.get('my-key')); // prints: undefined

// access all cookies
CookieUtil.getAll().forEach(([name, value]) => console.log(name, value)); // prints all cookies

HINT: Since most browsers have a strict cookie size limitation, the Persistore will throw an error if it would try to insert a cookie which exceeds the maximum size of 4093 bytes (iOS Safari reserves 3 additional bytes). The actual browser behaviour in that case would be to silently do nothing, what can lead to strange behaviour of your application. Therefore you should catch the possibly thrown error if you want to store large strings to handle this special case. Another useful information for you might be: localStorage and sessionStorage are not available on some browsers. The most common cases are iOS-Safari-Private-Mode users, where the Persistore will always fallback to cookies.

Configuration

It is also possible to make some configuration. For now it is only the key prefixing and an opt-out for secure cookies (useful for localhost development).

import { Persistore } from 'persistore';

Persistore.config({ prefix: 'myApp.', insecure: IS_LOCALHOST });