# storage-plus

> StoragePlus - A functional wrapper around native localStorage

Latest version **1.0.1** (published 2017-04-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install storage-plus
pnpm add storage-plus
yarn add storage-plus
bun add storage-plus
```

## 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 | 1.0.1 |
| Published | 2017-04-27 |
| First published | 2017-04-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | MaqicXu |
| Maintainers | maqicxu |
| Keywords | localStorage, storage, cookie |

## Links

- npm: https://www.npmjs.com/package/storage-plus
- Repository: https://github.com/maqic/storage-plus
- Homepage: https://github.com/maqic/storage-plus#readme
- Issues: https://github.com/maqic/storage-plus/issues
- npm.io page: https://npm.io/package/storage-plus

## Dependencies (1)

- [lodash](https://npm.io/package/lodash.md) ^4.17.4

## 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

- 1.0.1 (latest) — 2017-04-27
- 1.0.0 — 2017-04-27

## README

StoragePlus
==================================================

StoragePlus is a functional wrapper around native [localStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage).

The main differences with localStorage:

- no need for `JSON.stringify/parse`
- support setting cache time

Install
--------------------------------------

```bash
yarn add storage-plus
# or
npm install storage-plus --save
```

Usage
--------------------------------------

```javascript
import storagePlus from 'storage-plus';

var userInfo = { age: 10, name: 'Jack' };
var cacheTime = 7 * 24 * 3600 * 1000; // expired after seven days

storagePlus.setItem('userInfo', userInfo, cacheTime);
storagePlus.getItem('userInfo');
// => { age: 10, name: 'Jack' }
storagePlus.removeItem('userInfo');
```
Standalone build available as `dist/storage-plus.min.js`.

```html
<script src="./node_modules/storage-plus/dist/storage-plus.min.js"></script>
<script>
  storagePlus.setItem('flag', true, 1000);
</script>
```

API
--------------------------------------

### storagePlus.setItem(key, value, [cacheTime])

Set key to value with cacheTime(optional).

### storagePlus.getItem(key)

Get key's value. If expired, return `null`.

### storagePlus.removeItem(key)

Same as localStorage.removeItem(key).

License
--------------------------------------

Copyright © 2017 MaqicStudio - [MIT License](http://couto.mit-license.org/)

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