Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/emmo00/persisty
Simple Browser Local storage Abstraction. NPM package
https://github.com/emmo00/persisty
localstorage npm persisty simple
Last synced: about 15 hours ago
JSON representation
Simple Browser Local storage Abstraction. NPM package
- Host: GitHub
- URL: https://github.com/emmo00/persisty
- Owner: Emmo00
- License: mit
- Created: 2024-02-20T14:01:00.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-03-21T02:41:18.000Z (10 months ago)
- Last Synced: 2024-12-17T00:50:31.490Z (26 days ago)
- Topics: localstorage, npm, persisty, simple
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/persisty
- Size: 10.7 KB
- Stars: 5
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# persisty 💾
Simple Browser Local storage (and Session Storage) Abstraction.
Helps you work with browser localStorage (and sessionStorage) as a regular JavaScript object. It does this by allowing you use regular javascript object syntax.
## Installation
To use it just install from npm with the following command:
```bash
npm install persisty
```
## Usage
## Working with `localStorage`
When working with `localStorage`, you should import it as default like below:
### import `persisty`
```javascript
// import persisty
import persisty from 'persisty';
```
or as a named import:
### import `persistLocal`
```javascript
import { persistLocal } from 'persisty';
```
> [!NOTE]
> You have the flexibility to use either the import of `persisty` or `persistLocal`, as they refer to the same functionality.
### store
```javascript
const orders = [
{ id: 1, quantity: 2 },
{ id: 2, quantity: 1 },
];
persisty.orders = orders // Also saved in you browser localStorage
// or use persistLocal from named import:
persistLocal.orders = orders
```
### get
```javascript
console.log(persisty.orders);
// Output:
// [
// { id: 1, quantity: 2 },
// { id: 2, quantity: 1 },
// ];
```
### delete
```javascript
delete persisty.orders
console.log(persisty.orders); // null
```
## Working with `sessionStorage`
Import `persistSession` to interact with `sessionStorage`.
### import persistSession
```javascript
// import persisty
import { persistSession } from 'persisty';
```
### store
```javascript
const orders = [
{ id: 1, quantity: 2 },
{ id: 2, quantity: 1 },
];
persistSession.orders = orders // Also saved in you browser sessionStorage
```
### get
```javascript
console.log(persistSession.orders);
// Output:
// [
// { id: 1, quantity: 2 },
// { id: 2, quantity: 1 },
// ];
```
### delete
```javascript
delete persistSession.orders
console.log(persisty.orders); // null
```
----
> [!NOTE]
> persisty does not support deep mutation (yet).
For example:
```javascript
console.log(persisty.orders[0]) // { id: 1, quantity: 2 }
persisty.orders[0].id = 123
console.log(persisty.orders[0]) // { id: 1, quantity: 2 }
```
Won't work.
## Contribute
Issues/Feature request and PRs are welcome.
## License
[MIT](./LICENSE) License