localStorage, sessionStorage を操作しやすくする npm パッケージを作った

EasyStorage

概要

localStorage, sessionStorage の操作をしやすくする npm パッケージです。

上位互換だったり似たような拡張機能は相当あると思いますが、 npm, node.js ついでに github actions や jest の学習が主な目的です。

github

インストール

npm 経由でのインストールは後日設定するので、それまでは github 上から zip ダウンロードとかして dist/easy-storage.min.js を使って下さい

使い方

<script type="text/javascript" src="dist/easy-storage.min.js">

// localStorage を使う場合はどちらもOK
const Es = new EasyStorage();
const Es = new EasyStorage('local');

// sessionStorage を使う場合
const Es = new EasyStorage('session');

setItem(key, value)

localStorage, もしくは sessionStorage に指定のキーで値を格納します。

const Es = new EasyStorage();
// localStrage の 'test' キーに 1 が格納されます
Es.setItem('test', 1);

getItem(key)

localStorage, もしくは sessionStorage に格納された指定のキーの値を取り出します。

const Es = new EasyStorage();
// localStrage の 'test' キーに 1 が格納されます
Es.setItem('test', 1);
// 1 が console に出力されます
console.log(Es.getItem('test'));

removeItem(key)

localStorage, もしくは sessionStorage に格納された指定のキーの値を削除します

const Es = new EasyStorage();
// localStrage の 'test' キーに 1 が格納されます
Es.setItem('test', 1);
// 'test' キーが削除されます
Es.removeItem('test');

clear()

localStorage, もしくは sessionStorage に格納された指定のキーの値を削除します

const Es = new EasyStorage();
// localStrage の 'test1' キーに 1 が格納されます
Es.setItem('test1', 1);
// localStrage の 'test2' キーに 2 が格納されます
Es.setItem('test2', 2);
// 全てのキー（'test1', 'test2'） キーが削除されます
Es.clear();

hasItem(key)

localStorage, もしくは sessionStorage に指定のキーが格納されているか判定します

const Es = new EasyStorage();
// localStrage の 'test' キーに 1 が格納されます
Es.setItem('test', 1);
// 'test' キーは格納されているため true が返却される
Es.hasItem('test');
// 'failure' キーは格納されていないため false が返却される
Es.hasItem('failure');

使っていただける方へお願い

他に欲しい機能を思いついたり不具合に気付いたりしましたらこちらのコメントもしくは github の issue にください。確認次第対応します。