1.0.0 • Published 7 years ago

generics-storage v1.0.0

Weekly downloads
2
License
MIT
Repository
github
Last release
7 years ago

generics-storage

local storage for any implementation or cookie with immutable-helper update

npm version Coverage Status Build Status

Installation

yarn add immutable-helper generics-storage

or

npm install immutable-helper generics-storage --save

Simple usage

import {GenericsStorage} from 'generics-storage';

const storage = new GenericsStorage(); // default storage is cookie
const query = {$push: [1, 2, "test"]}; // immutable-helper query

storage.update("some-field", query);

storage.getValue("some-field");
// should be an array [1, 2, "test"]

storage.remove("some-field");
// undefined

API

MethodArgument(Type)Return TypeDescription
updatekey: string, query: objectvoidupdate current object or array to key by query
getValuekey: stringobject or ArrayGet value (object or array) from key
removekey: stringvoidClean data of key

Custom your storage (optional)

import * as Cookies from 'js-cookie';
import {Storage, GenericsStorage} from 'generics-storage';

export class CookieStorage implements Storage {
    setItem(key, value) {
        Cookies.set(key, value);
    }

    getItem(key) {
        return Cookies.get(key);
    }

    removeItem(key) {
        Cookies.remove(key);
    }
}

const cookie = new CookieStorage();
export const storage = new GenericsStorage(cookie);

Contributing

npm test