# bstorage

> Browser local-storage wrapper

Latest version **2.0.4** (published 2019-02-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install bstorage
pnpm add bstorage
yarn add bstorage
bun add bstorage
```

## 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.4 |
| Published | 2019-02-25 |
| First published | 2016-08-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=7.6 |
| Dependencies | 2 |
| Unpacked size | 30.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Taka Okunishi |
| Maintainers | okunishinishi |
| Keywords | localStorage |

## Links

- npm: https://www.npmjs.com/package/bstorage
- Repository: https://github.com/b-labo/bstorage
- Homepage: https://github.com/b-labo/bstorage#readme
- Issues: https://github.com/b-labo/bstorage/issues
- npm.io page: https://npm.io/package/bstorage

## Dependencies (2)

- [qs](https://npm.io/package/qs.md) ^6.6.0
- [bwindow](https://npm.io/package/bwindow.md) ^2.0.2

## Alternatives

- [localforage](https://npm.io/package/localforage.md) — 6.2M weekly downloads
- [localforage-observable](https://npm.io/package/localforage-observable.md) — 30.8K weekly downloads
- [@y/y](https://npm.io/package/@y/y.md) — 30.1K weekly downloads
- [@metaobjectsdev/render](https://npm.io/package/@metaobjectsdev/render.md) — 3.5K weekly downloads
- [@ledgerhq/coin-algorand](https://npm.io/package/@ledgerhq/coin-algorand.md) — 1.1K weekly downloads

## Recent versions

- 2.0.4 (latest) — 2019-02-25
- 2.0.3 — 2018-08-13
- 2.0.2 — 2018-08-12
- 2.0.1 — 2017-09-17
- 2.0.0 — 2017-09-17
- 1.1.1 — 2016-10-31
- 1.1.0 — 2016-10-14
- 1.0.3 — 2016-10-12
- 1.0.2 — 2016-10-12
- 1.0.1 — 2016-09-21
- 1.0.0 — 2016-08-15

## README

bstorage
==========

<!---
This file is generated by ape-tmpl. Do not update manually.
--->

<!-- Badge Start -->
<a name="badges"></a>

[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]
[![JS Standard][bd_standard_shield_url]][bd_standard_url]

[bd_repo_url]: https://github.com/b-labo/bstorage
[bd_travis_url]: http://travis-ci.org/b-labo/bstorage
[bd_travis_shield_url]: http://img.shields.io/travis/b-labo/bstorage.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/b-labo/bstorage
[bd_travis_com_shield_url]: https://api.travis-ci.com/b-labo/bstorage.svg?token=
[bd_license_url]: https://github.com/b-labo/bstorage/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/b-labo/bstorage
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/b-labo/bstorage.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/b-labo/bstorage.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/b-labo/bstorage
[bd_gemnasium_shield_url]: https://gemnasium.com/b-labo/bstorage.svg
[bd_npm_url]: http://www.npmjs.org/package/bstorage
[bd_npm_shield_url]: http://img.shields.io/npm/v/bstorage.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

<!-- Badge End -->


<!-- Description Start -->
<a name="description"></a>

Browser local-storage wrapper

<!-- Description End -->


<!-- Overview Start -->
<a name="overview"></a>



<!-- Overview End -->


<!-- Sections Start -->
<a name="sections"></a>

<!-- Section from "doc/guides/01.Installation.md.hbs" Start -->

<a name="section-doc-guides-01-installation-md"></a>

Installation
-----

```bash
$ npm install bstorage --save
```


<!-- Section from "doc/guides/01.Installation.md.hbs" End -->

<!-- Section from "doc/guides/02.Usage.md.hbs" Start -->

<a name="section-doc-guides-02-usage-md"></a>

Usage
---------

```javascript
'use strict'

const {save, restore, purge} = require('bstorage')

// Set to localStorage
save('foo', {msg: 'This is foo'})

// Get from localStorage
console.log(restore('foo')) // -> { msg: 'This is foo' }

// Remove from localStorage
purge('foo')

```


<!-- Section from "doc/guides/02.Usage.md.hbs" End -->


<!-- Sections Start -->


<!-- LICENSE Start -->
<a name="license"></a>

License
-------
This software is released under the [MIT License](https://github.com/b-labo/bstorage/blob/master/LICENSE).

<!-- LICENSE End -->


<!-- Links Start -->
<a name="links"></a>

Links
------



<!-- Links End -->

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