storage-control

localStorage & sessionStorage control library

Usage

html

<script src="dist/storage-control.js"></script>

npm

Install to project

$ npm i -D storage-control

Write to javascript files

import StorageControl from 'stroage-control'

Document

initialize

const storage = new StorageControl('local')

| string | used | | --- | --- | | local | window.localStorage | | session | window.sessionStorage |

'session'以外の値だったときはlocalStorageを使用。

save(key, val)

データをkey-valueで記録。
メソッドチェーン可能。

argument

| param | type | description | | --- | --- | --- | | key | string | キー名 | | val | number | string | Array | object | 登録したいデータ |

return

StorageControl Object

example

// number
storage.save('num', 0)

// string
storage.save('str', 'foobar')

// array
storage.save('arr', [0, 'foo', 3])

// object
storage.save('obj', {foo: 'foo', bar: 1})

// method chain
storage
  .save('num', 0)
  .save('str', 'foobar')

get(key)

存在しない場合はNULL、存在する場合は保存した型(number | string | Array | object)で返却。

argument

| param | type | description | | --- | --- | --- | | key | string | キー名 |

return

NULL | number | string | Array | object

example

const res = storage.get('str')

remove(key)

キー名を指定してデータをキー名ごと削除。
メソッドチェーン可能。

argument

| param | type | description | | --- | --- | --- | | key | string | キー名 |

return

StorageControl Object

example

storage.remove('str')

// method chain
storage
  .remove('str')
  .remove('foobar')

clear()

ストレージの中身をすべて削除。

[WARNING] 自身で操作したデータ以外に、Chrome拡張機能などで自動的にデータが挿入されている場合、そのデータも削除されます。

example

storage.clear()