stockpile.js
v1.2.1
Published
A tiny localStorage wrapper providing namespacing and typed values.
Downloads
11
Readme
Stockpile.js
A tiny localStorage wrapper providing namespacing and typed values.
Usage
Stockpile was developed with a modern JavaScript workflow in mind. To use it, it's recommended you have a build system in place that can transpile ES6, and bundle modules. For a minimal boilerplate that does so, check out outset.
Follow these steps to get started:
Then dig into the API.
Install
Using NPM, install Stockpile.js, and add it to your package.json
dependencies.
$ npm install stockpile.js --save
Call
Import Stockpile, then call it.
- Pass it your
namespace
string.
// import Stockpile
import stockpile from 'stockpile.js'
// create or retrieve your namespaced storage
const storage = stockpile('namespace')
API
Note that the API mimics the return values of the Storage API.
However, whereas the Storage API supports only string values, Stockpile supports getting and setting of all JavaScript's primitive types, as well as Arrays and Objects.
.get(name)
Get a key's value.
storage.get('name')
.set(name, value)
Set a key's value.
storage.set('string', 'string')
storage.set('number', 1)
storage.set('boolean', true)
storage.set('array', [1, 2, 3])
storage.set('object', { key: 'value' })
.remove(name)
Delete a key/value pair.
storage.remove('name')
.clear()
Delete the namespace.
storage.clear()
.exists(name)
Check if a key/value pair exists in the namespace.
storage.exists('name')
Returns true if it exists, false otherwise.
License
MIT. © 2016 Michael Cavalea