0.0.4 • Published 11 months ago

azz-storage v0.0.4

Weekly downloads
-
License
ISC
Repository
github
Last release
11 months ago

Azz Storage

This is a handy wrapper for web localStorage for now

Support localStorage, sessionStorage, and InMemory Storage

Installation

npm install --save azz-storage

Usage

import { LocalStorage } from "azz-storage";
// import { SessionStorage } from "azz-storage";
// import { MemoryStorage } from "azz-storage";

const lStore = new LocalStorage("__pro");

lStore.set("token", "logined"); // Will save key as __protoken in localStorage

lStore.get("token"); // "logined"

with parser like vue-ls

const vueLSLikeParser: IStorageParser = {
  getVal(val: string, defaultVal: unknown): unknown {
    try {
      const data = JSON.parse(val);
      return data.value;
    } catch (e) {
      return defaultVal;
    }
  },
  setVal(val: unknown) {
    return JSON.stringify({
      value: val,
    });
  },
};

const localVueLikeStore = new LocalStorage("__vuels", vueLSLikeParser);

API

Storage

Contructor

import { LocalStorage }  from "azz-storage";
// SessionStorage and MemoryStorage have same api with LocalStorage

const lStore = new LocalStorage([keyPrefix, parser]);
argumenttypedescriptiondefaultrequired
keyPrefixstringthe key prefix for preventing conflict in your web app with other libraryundefinedtrue
parserIAzzStorageParserfor sepecific use, liking auto JSON parse/stringify like vue-ls or do some logundefinedfalse

Instance APi

lStore.get([key, defaultVal]);
lStore.set([key, val]);
lStore.remove([key]);
methodargumenttypedescriptiondefaultrequired
getkeystringthe storage keyundefinedtrue
getdefaultValunknownwhen the target value not defined, you will get the default oneundefinedfalse
setkeystringsame as get method keyundefinedtrue
setvalunknownthe val you want to saveundefinedtrue
removekeyremoveremove key mapped valueundefinedtrue
0.0.4

11 months ago

0.0.3

2 years ago

0.0.2

2 years ago

0.0.1

3 years ago