# simple-local-storage

> A simple localStorage abstraction

Latest version **1.0.3** (published 2015-05-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install simple-local-storage
pnpm add simple-local-storage
yarn add simple-local-storage
bun add simple-local-storage
```

## 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.3 |
| Published | 2015-05-06 |
| First published | 2015-05-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Julian Hollmann |
| Maintainers | nerdbeere |

## Links

- npm: https://www.npmjs.com/package/simple-local-storage
- Repository: https://github.com/nerdbeere/simple-local-storage
- Issues: https://github.com/nerdbeere/simple-local-storage/issues
- npm.io page: https://npm.io/package/simple-local-storage

## Recent versions

- 1.0.3 (latest) — 2015-05-06
- 1.0.2 — 2015-05-06
- 1.0.1 — 2015-05-05
- 1.0.0 — 2015-05-05

## README

# Simple Local Storage

A simple localStorage abstraction to get and set strings, arrays and objects from and to localStorage.

**Warning:** This is currently only working in the browser because localStorage is not implemented in nodejs/iojs.

## Installation

`npm install --save simple-local-storage`

## Api

### `store.get(key)`

#### Parameters:

Name | Type | Description
-----|------|------------
key | `string` | The key of the item

Retrieve an item from the store.

### `store.set(key, value)`

#### Parameters:

Name | Type | Description
-----|------|------------
key | `string` | The key of the item
value | `array`, `object`, `string`, `number` | The actual value you want to save in the store

Save an item to the store.

### `store.remove(key)`

#### Parameters:

Name | Type | Description
-----|------|------------
key | `string` | The key of the item

Remove an item from the store.

### `store.clear()`

Remove all items from the store.

## License

The MIT License (MIT)

Copyright (c) 2015 Julian Hollmann

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

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