Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kotarella1110/typesafe-storage

Typesafe Web Storage API wrapper to support objects and arrays
https://github.com/kotarella1110/typesafe-storage

localstorage sessionstorage storage store typesafe typescript webstorage

Last synced: 3 months ago
JSON representation

Typesafe Web Storage API wrapper to support objects and arrays

Host: GitHub
URL: https://github.com/kotarella1110/typesafe-storage
Owner: kotarella1110
License: mit
Created: 2020-04-07T05:19:06.000Z (almost 5 years ago)
Default Branch: master
Last Pushed: 2023-01-06T02:53:17.000Z (about 2 years ago)
Last Synced: 2024-10-03T08:05:02.594Z (4 months ago)
Topics: localstorage, sessionstorage, storage, store, typesafe, typescript, webstorage
Language: TypeScript
Homepage: https://www.npmjs.com/package/typesafe-storage
Size: 2.25 MB
Stars: 3
Watchers: 2
Forks: 0
Open Issues: 18
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


typesafe-storage


Typesafe [Web Storage API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Storage_API) wrapper to support objects and arrays.

[![License](https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square)](LICENSE)

[![Actions Status](https://github.com/kotarella1110/typesafe-storage/workflows/CI/badge.svg)](https://github.com/kotarella1110/typesafe-storage/actions?query=workflow%3ACI)

[![NPM Version](https://img.shields.io/npm/v/typesafe-storage?style=flat-square)](https://www.npmjs.com/package/typesafe-storage)

[![Downloads Month](https://img.shields.io/npm/dm/typesafe-storage?style=flat-square)](https://www.npmjs.com/package/typesafe-storage)

[![Downloads Total](https://img.shields.io/npm/dt/typesafe-storage?style=flat-square)](https://www.npmjs.com/package/typesafe-storage)

[![Dependencies Status](https://david-dm.org/kotarella1110/typesafe-storage.svg?style=flat-square)](https://david-dm.org/kotarella1110/typesafe-storage)

[![Semantic Release](https://img.shields.io/badge/%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)](https://github.com/semantic-release/semantic-release)

[![Commitizen Friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square)](http://commitizen.github.io/cz-cli/)

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-green.svg?style=flat-square)](CONTRIBUTING.md)

[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)



## Installation

```

npm install typesafe-storage

# or

yarn add typesafe-storage

```

## Usage

[CodeSandbox](https://codesandbox.io/s/typesafe-storage-msl4z)

```ts

import { createStorage } from "typesafe-storage";

const storage = createStorage<{

  string: string;

  number: number;

  object: {

    string: string;

    number: number;

  };

  array: (string | number)[];

}>(localStorage);

storage.setItem("string", "value");

storage.setItem("number", 1);

storage.setItem("number", "error"); // ❌: Argument of type '"error"' is not assignable to parameter of type 'number'.

storage.setItem("object", {

  string: "value",

  number: 1

});

storage.setItem("array", ["value", 1]);

storage.setItem("notExistKey", "value"); // ❌: Argument of type '"notExistKey"' is not assignable to parameter of type '"string" | "number" | "object" | "array"'.

storage.getItem("string");

storage.getItem("number");

storage.getItem("object");

storage.getItem("array");

storage.getItem("notExistKey"); // ❌: Argument of type '"notExistKey"' is not assignable to parameter of type '"string" | "number" | "object" | "array"'.

storage.removeItem("string");

storage.removeItem("number");

storage.removeItem("object");

storage.removeItem("array");

storage.removeItem("notExistKey"); // ❌: Argument of type '"notExistKey"' is not assignable to parameter of type '"string" | "number" | "object" | "array"'.

storage.clear();

```

## Contributing

Contributions are always welcome! Please read the [contributing](./CONTRIBUTING.md) first.

## Contributors

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    
_{Kotaro Sugawara}
💻 📖 🤔 🚇 ⚠️

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

## License

[MIT](./LICENSE) © [Kotaro Sugawara](https://twitter.com/kotarella1110)