# browser-store

> Async browser storage with Node fallback

Latest version **2.0.2** (published 2015-11-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install browser-store
pnpm add browser-store
yarn add browser-store
bun add browser-store
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.2 |
| Published | 2015-11-03 |
| First published | 2015-08-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6 |
| Author | Ben Drucker |
| Maintainers | bendrucker |
| Keywords | browser, storage, localStorage, sessionStorage |

## Links

- npm: https://www.npmjs.com/package/browser-store
- Repository: https://github.com/bendrucker/browser-store
- Homepage: https://github.com/bendrucker/browser-store#readme
- Issues: https://github.com/bendrucker/browser-store/issues
- npm.io page: https://npm.io/package/browser-store

## Dependencies (5)

- [global](https://npm.io/package/global.md) ~4.3.0
- [storage-sham](https://npm.io/package/storage-sham.md) ~1.0.0
- [has-local-storage](https://npm.io/package/has-local-storage.md) ~1.0.1
- [browser-async-store](https://npm.io/package/browser-async-store.md) ~1.0.0
- [has-session-storage](https://npm.io/package/has-session-storage.md) ~1.0.1

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 2.0.2 (latest) — 2015-11-03
- 2.0.1 — 2015-10-01
- 2.0.0 — 2015-09-27
- 1.0.2 — 2015-09-01
- 1.0.1 — 2015-08-31
- 1.0.0 — 2015-08-31

## README

# browser-store [![Build Status](https://travis-ci.org/bendrucker/browser-store.svg?branch=master)](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)

---
_Source: https://npm.io/package/browser-store · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._