Keeper for handling browser and node storages
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

Storage Keeper

npm version renovate-app Known Vulnerabilities codecov travis

This library provide simple way how to interact with storages that are based on browser (localstorage, sessionstorage, cookie) or node (fs). It provides same interface for handling all of them.

Storage have only three methods:

  • Get key
  • Set key (optionally set expiration date)
  • Delete key

Values can be strings, numbers or objects. Object will be saved as JSON in storage.

How to use it

Install the library:

npm install storage-keeper --save

Now you can use native browser storages: .

import { LocalStorage } from 'storage-keeper';

const storage = new LocalStorage('prefix');

storage.set('userId', 6);
storage.set('user', 'paprika');
storage.set('user', { name: 'paprika' });

// add expiration date
storage.set('signed', true, new Date('2018-05-01'));

console.log(storage.get('signed'));

storage.remove('signed');

How to use adapters

You can use adapters for fs and cookies:

import { Storage } from 'storage-keeper';
import CookieAdapter  from 'storage-keeper/dist/adapters/CookieAdapter';

const storage = new Storage('prefix', new CookieAdapter());

storage.set('some-value', 'x');

For storing values in file on node:

import { Storage } from 'storage-keeper';
import FileAdapter  from 'storage-keeper/dist/adapters/FileAdapter';

const storage = new Storage('prefix', new FileAdapter('path-to-file'));

storage.set('some-value', 'x');

You can create your own adapter, just use following interface:

interface Adapter {
    getItem(key: string): ?string;
    setItem(key: string, data: string): void;
    removeItem(key: string): void;
}