# typescript-web-storage

> This package provides a typed, common interface for LocalStorage, SessionStorage, and WebStorage

Latest version **1.0.0-alpha.1** (published 2021-09-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install typescript-web-storage
pnpm add typescript-web-storage
yarn add typescript-web-storage
bun add typescript-web-storage
```

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0-alpha.1 |
| Published | 2021-09-21 |
| First published | 2021-09-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 33.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | roydukkey |
| Maintainers | roydukkey |
| Keywords | typed, storage, variables, local-storage, session-storage, web-storage, events, typescript |

## Links

- npm: https://www.npmjs.com/package/typescript-web-storage
- Repository: https://github.com/roydukkey/typescript-storage
- Homepage: https://github.com/roydukkey/typescript-storage/tree/master/packages/typescript-web-storage#readme
- Issues: https://github.com/roydukkey/typescript-storage/issues
- npm.io page: https://npm.io/package/typescript-web-storage

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 1.0.0-alpha.1 (latest) — 2021-09-21
- 1.0.0-alpha.0 — 2021-09-21

## README

# typescript-web-storage

This package provides typed interface for LocalStorage, SessionStorage, and WebStorage.

[![Release Version](https://img.shields.io/npm/v/typescript-web-storage.svg)](https://www.npmjs.com/package/typescript-web-storage)
[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

## Install

```bash
npm install typescript-web-storage
```

## Web Storage API

```ts
import { LocalStorage, SessionStorage, WebStorage } from 'typescript-web-storage';
```

`LocalStorage`, `SessionStorage`, and `WebStorage` all provide a similar interface as JavaScript's native [`Storage`](https://developer.mozilla.org/en-US/docs/Web/API/Storage) interface.

### Properties

#### `readonly length: number`
Returns the number of key/value pairs currently present in storage.

#### `protected readonly store: Storage`
The [Web Storage API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Storage_API) instance on which to add, update, or delete store values.

### Methods

#### `getItem <T> (key: string): T | null`
Returns the current value associated with the given key, or null if the given key does not exist in storage.

#### `setItem <T> (key: string, value: T): this`
Stores the value of an existing pair, identified by given key, to the specified value; otherwise, creating a new key/value pair when none previously exists.

#### `removeItem (key: string): this`
Removes the key/value pair for the given key from storage, if the key/value pair exists.

#### `key (index: number): string | null`
Returns the name of the key at the given index, or null if the index is greater than or equal to the number of key/value pairs in storage.

#### `clear (): this`
Empties all key/value pairs from storage, if there are any.

### Listener Methods

Methods to add and remove listeners to specific storage keys have also been added to allow typed values during event handling.

```ts
import { LocalStorage } from 'typescript-web-storage';

const storage = new LocalStorage();

const listener = store.addListener('my_bool', (event) => {
  const { oldValue, newValue } = event;
  console.log(typeof oldValue, typeof newValue);
    // => 'boolean', 'boolean'
});

store.setItem('my_bool', true);

store.removeListener('my_bool', listener);

// Or, to remove all listeners on the key.
store.removeListener('my_bool');

```

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