Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/script47/local-storage
A handy wrapper around localStorage.
https://github.com/script47/local-storage
local-storage local-storage-api localstorage ls persistance persistant-storage persistantstorage storage
Last synced: 3 months ago
JSON representation
A handy wrapper around localStorage.
- Host: GitHub
- URL: https://github.com/script47/local-storage
- Owner: Script47
- License: mit
- Created: 2022-10-23T22:23:36.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2022-11-01T01:01:42.000Z (about 2 years ago)
- Last Synced: 2024-09-14T01:03:55.681Z (4 months ago)
- Topics: local-storage, local-storage-api, localstorage, ls, persistance, persistant-storage, persistantstorage, storage
- Language: JavaScript
- Homepage:
- Size: 78.1 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# `@script47/local-storage`
A handy wrapper around localStorage.
- What you see is what you get; Simple and clean wrapper, nothing extra
- Respects types; no longer do you have to worry about casting items after retrieving them
- Custom events on actions; listen to events on `set`, `remove`, and `clear`
**Note:** This wrapper will not work if the `localStorage` API is not available.
## Contents
- [Installation](#installation)
- [API](#api)
- [Playground](https://jsfiddle.net/m2ewytr6/)
## Installation
#### via NPM
```shell
npm i @script47/local-storage
```
#### via CDN
```html
```
## API
#### Set or get a key using the quick accessor:
```javascript
ls(key, value);
```
#### Example
```javascript
ls('key', 'value'); // true
// or
ls({
key: 'value'
});
ls('key'); // 'value'
```
---
#### Set a local storage item:
```javascript
set(key, value);
```
#### Example
```javascript
ls.set('key', 'value'); // true
// or
ls.set({
key: 'value'
})
```
---
#### Get a local storage item:
```javascript
get(key, def = undefined);
```
#### Example
```javascript
ls.set('key', 'value'); // true
ls.set('key', 'default value'); // 'value'
ls.get('i-dont-exist', 'default value'); // 'default value'
ls.get('i-dont-exist'); // undefined
```
---
#### Remove a local storage item:
```javascript
remove(key);
```
#### Example
```javascript
ls.set('key', 'value'); // true
ls.get('key'); // 'value'
ls.remove('key'); // true
// or
ls.remove(['key']);
ls.get('key'); // undefined
```
---
#### Clear local storage completely:
```javascript
clear();
```
#### Example
```javascript
ls.set('key', 'value'); // true
ls.set('another-key', 'another-value'); // true
ls.clear(); // true
ls.get('key'); // undefined
ls.get('another-key'); // undefined
```
---
#### Listen to events attached to localStorage actions by the package:
```javascript
on(type, listener);
```
#### Example
```javascript
ls.on('ls.set', ({detail}) => {
console.log(`${detail.key}=${detail.value}`);
});
ls.on('ls.remove', ({detail}) => {
console.log(`${detail.key} was removed.`);
});
ls.on('ls.clear', () => {
console.log('localStorage was cleared.');
})
ls.set('name', 'John Doe');
ls.set('age', 35);
setTimeout(() => {
ls.remove('name');
setTimeout(() => {
ls.clear();
}, 2500);
}, 2500);
```