# local-storage-vir

> Simple wrapper for defining local storage key-value pairs.

Latest version **0.1.0** (published 2023-01-11) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2023-01-11 |
| First published | 2023-01-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 9.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | electrovir |
| Maintainers | electrovir |
| Keywords | local, storage, wrapper, typed, key-value, pairs, data, browser, esm |

## Links

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

## Dependencies (1)

- [@augment-vir/common](https://npm.io/package/@augment-vir/common.md) ^6.4.0

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

- 0.1.0 (latest) — 2023-01-11
- 0.0.0 — 2023-01-10

## README

# local-storage-vir

Simple wrapper for defining local storage key-value pairs.

# Install

```bash
npm i local-storage-vir
```

# Usage

<!-- example-link: src/readme-examples/no-default.example.ts -->

```TypeScript
import {createLocalStorageAccessor} from 'local-storage-vir';

type MyStoredType = Record<string, number>;
const myStorageAccessor = createLocalStorageAccessor<MyStoredType>({
    key: 'my-key',
});

// set the value
myStorageAccessor.set({keyA: 4});

// get the value
const currentValue: MyStoredType | undefined = myStorageAccessor.get();

// remove the value
myStorageAccessor.remove();
```

## With Default value

Provide a default value to eliminate `undefined` from the `get()` output:

<!-- example-link: src/readme-examples/with-default.example.ts -->

```TypeScript
import {createLocalStorageAccessor} from 'local-storage-vir';

type MyStoredType = Record<string, number>;
const myStorageAccessor = createLocalStorageAccessor<MyStoredType>({
    key: 'my-key',
    default: {five: 5},
});

// the get value will always be defined due to the default provided above
const currentValue: MyStoredType = myStorageAccessor.get();
```

## With sanitizer

Use `setSanitizer` to sanitize values passed to `.set()`:

<!-- example-link: src/readme-examples/with-sanitizer.example.ts -->

```TypeScript
import {createLocalStorageAccessor} from 'local-storage-vir';

const myStoredNumber = createLocalStorageAccessor<number>({
    key: 'my-key',
    setSanitizer: (input) => {
        // prevent negative values
        return Math.abs(input);
    },
});

myStoredNumber.set(-4); // this will set the value 4
```

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