# local-persist

> A simplified client localStorage API

Latest version **1.2.0** (published 2020-12-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install local-persist
pnpm add local-persist
yarn add local-persist
bun add local-persist
```

## 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.2.0 |
| Published | 2020-12-12 |
| First published | 2020-12-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 15.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Richard Do |
| Maintainers | anhdo5995 |
| Keywords | local persist, local storage, persistent, local persistant |

## Links

- npm: https://www.npmjs.com/package/local-persist
- Repository: https://github.com/anhdo95/local-persist
- Homepage: https://github.com/anhdo95/local-persist#readme
- Issues: https://github.com/anhdo95/local-persist/issues
- npm.io page: https://npm.io/package/local-persist

## 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.2.0 (latest) — 2020-12-12
- 1.1.1 — 2020-12-06
- 1.1.0 — 2020-12-06
- 1.0.0 — 2020-12-06

## README

# local-persist
A simplified client `localStorage` API, including typescript support already!

# Install
Using `npm`
```shell
npm install local-persist --save
```

Using `yarn`
```shell
yarn add local-persist
```

# API

The API is a simplified way to interact with all things `localStorage`. Note that when `localStorage` is unsupported in the current browser, a fallback to an in-memory store is used transparently.

## `localPersist(key, value?)`

If a `value` argument is provided, acts as `localPersist.set`. When `value` isn't provided, acts as `localPersist.get`.

##### Example

```js
var localPersist = require('local-persist');

localPersist('key');
// <- null

localPersist('key', 'value');
// <- true

localPersist('key');
// <- 'value'
```

## `localPersist.get(key)`

Returns value under `key` in local storage. Equivalent to `localPersist(key)`.

##### Example

```js
var localPersist = require('local-persist');

localPersist('key', 'value');
// <- true

localPersist.get('key');
// <- 'value'
```

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

Persists `value` under `key` in local storage. Equivalent to `localPersist(key, value)`

##### Example

```js
var localPersist = require('local-persist');

localPersist.set('key', 'value');
// <- true

localPersist.get('key');
// <- 'value'
```

## `localPersist.remove(key)`

Removes `key` from local storage. Returns `true` if the property was successfully deleted, and `false` otherwise.

##### Example

```js
var localPersist = require('local-persist');

localPersist.set('key', 'value');
// <- true

localPersist.remove('key');
// <- true
```

## `localPersist.clear()`

Clears local storage.

##### Example

```js
var localPersist = require('local-persist');

localPersist.set('key1', 'value1');
localPersist.set('key2', 'value2');
localPersist.clear();
```

## Typescript now is available!

##### Example

```ts
import localPersist from "local-persist";

localPersist('foo', bar)
localPersist.set<number>('foo', 2);
localPersist.get<boolean>('bar', true);

interface Foo{
  bar: string;
}

localPersist<Foo>('foo');
```

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