https://github.com/bendrucker/browser-store
Async browser storage with Node fallback
https://github.com/bendrucker/browser-store
Last synced: 5 months ago
JSON representation
Async browser storage with Node fallback
- Host: GitHub
- URL: https://github.com/bendrucker/browser-store
- Owner: bendrucker
- License: mit
- Created: 2015-08-31T21:25:30.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2018-11-13T18:49:42.000Z (over 7 years ago)
- Last Synced: 2025-10-11T05:04:26.260Z (10 months ago)
- Language: JavaScript
- Homepage:
- Size: 8.79 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# browser-store [](https://travis-ci.org/bendrucker/browser-store)
> Async browser storage with Node fallback
Uses local storage, then session storage, then an in-memory store if neither are available.
## Install
```
$ npm install --save browser-store
```
## Usage
```js
var store = require('browser-store')
store.put('foo', 'bar', function (err) {
//=> err === null
store.get('foo', function (err, value) {
//=> err === null
//=> value === 'bar'
})
})
```
## API
#### `store.get(key, callback)` -> `undefined`
Get data from the store. Parses as JSON.
##### key
*Required*
Type: `string`
##### callback
*Required*
Type: `function`
Arguments: `err, value`
#### `store.put(key, value, [callback])` -> `undefined`
Add an item to the store (or overwrite an existing item). Data will be stringified as JSON.
##### key
*Required*
Type: `string`
##### value
*Required*
Type: `any`
##### callback
*Required*
Type: `function`
Arguments: `err`
#### `store.remove(key, [callback])` -> `undefined`
Remove an item.
##### key
*Required*
Type: `string`
##### callback
*Required*
Type: `function`
Arguments: `err`
#### `store.clear([callback])` -> `undefined`
Clear the store.
##### callback
*Required*
Type: `function`
Arguments: `err`
## Related
* [browser-async-store](https://github.com/bendrucker/browser-async-store): the engine for browser-store
* [browser-store](https://github.com/bendrucker/browser-store): an API compatible alternative that only uses `sessionStorage`
## License
MIT © [Ben Drucker](http://bendrucker.me)