https://github.com/sutanlab/simple-webstorage
Lightweight utilities that can make easier to access application storage in client browser.
https://github.com/sutanlab/simple-webstorage
javascript javascript-library javascript-utility local-storage npm-package session-cookie web-storage
Last synced: 4 months ago
JSON representation
Lightweight utilities that can make easier to access application storage in client browser.
- Host: GitHub
- URL: https://github.com/sutanlab/simple-webstorage
- Owner: gadingnst
- License: mit
- Created: 2019-03-14T04:31:36.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-10-22T12:29:05.000Z (over 2 years ago)
- Last Synced: 2024-05-22T23:42:15.133Z (11 months ago)
- Topics: javascript, javascript-library, javascript-utility, local-storage, npm-package, session-cookie, web-storage
- Language: JavaScript
- Homepage: https://sutanlab.js.org/simple-webstorage
- Size: 73.2 KB
- Stars: 11
- Watchers: 1
- Forks: 6
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-indonesia-repo - Simple Web Storage - Lightweight utilities that can make easier to access application storage in client browser. (JavaScript)
- awesome-indo-projects - Simple Web Storage - Lightweight utilities that can make easier to access application storage in client browser. (JavaScript)
README
# Simple Web Storage
[](https://github.com/sutanlab/simple-webstorage) [](https://app.codacy.com/app/sutanlab/simple-webstorage?utm_source=github.com&utm_medium=referral&utm_content=sutanlab/simple-webstorage&utm_campaign=Badge_Grade_Dashboard) [](https://travis-ci.org/sutanlab/simple-webstorage) [](https://www.npmjs.com/package/simple-webstorage) [](https://npm-stat.com/charts.html?package=simple-webstorage) [](https://unpkg.com/simple-webstorage/lib/bundle/simple-webstorage.min.js) [](https://www.npmjs.com/package/simple-webstorage?activeTab=dependencies) [](https://github.com/sutanlab/simple-webstorage/issues) [](https://sutanlab.js.org/simple-webstorage)
> Lightweight utilities that can make easier to write and read application storage in client browser.
### Support :
- Local Storage
- Cookie Storage
- Session Storage
---
## HOW TO USE
### 1. Use Package with NPM or YARN
```bash
# with npm
$ npm i simple-webstorage --save
# or with yarn
$ yarn add simple-webstorage
```
#### All API import
```js
import SimpleWebStorage from 'simple-webstorage'
const storage = SimpleWebStorage()
storage.local.set('key', 'value') // empty the third parameter to store data permanently (only affected in local)
storage.cookie.set('key', 'value', 5)
storage.session.set('key', 'value', 5)
```
#### Partial API import
```js
// # for local storage
import { get as getLocalStorage, set as setLocalStorage } from 'simple-webstorage/lib/local'
// # for session storage
// import { get, set } from 'simple-webstorage/lib/session'
// # for cookie storage
// import { get, set } from 'simple-webstorage/lib/cookie'
setLocalStorage('key', {
name: 'you',
skill: [
'angry',
'crying'
]
})
console.log(getLocalStorage('key')) // { name: 'you', skill: ['angry', 'crying'] }
```
##### or you can import partial API like this :
```js
// # for cookie storage
import CookieStorage from 'simple-webstorage/lib/cookie'
// # for local storage
// import LocalStorage from 'simple-webstorage/lib/local'
// # for session storage
// import SessionStorage from 'simple-webstorage/lib/session'
const cookie = CookieStorage()
cookie.set('remembered', true)
cookie.set('forgotten', true)
console.log(cookie.get('remembered')) // true # get values from key. returns any
console.log(cookie.keys()) // ['remembered', 'forgotten'] # list all keys. returns array
```
### 2. All in minified js
```html
var storage = SimpleWebStorage();
storage.local.set('key', 'value');
storage.cookie.set('key', 'value', 5);
storage.session.set('key', 'value', 5);
```
## API Details
| Storage | Method | Parameters |
|-----------|-------------|---------------------------------------------------------------------------------------------|
| `local` | set | `key` (type: String), `value` (type: any, default: 0), `expiryInMinutes` (type: Number, default: null) |
| `cookie` or `session` | set | `key` (type: String), `value` (type: any, default: 0), `expiryInMinutes` (type: Number, default: 5) |
| `local` or `cookie` or `session` | get | `key` (type: String) |
| `local` or `cookie` or `session` | remove | `key` (type: String) |
| `local` or `cookie` or `session` | keys | none |
| `local` or `cookie` or `session` | clear | none |
## Support Me
### Global
[](https://ko-fi.com/gadingnst)
### Indonesia
- [Trakteer](https://trakteer.id/gadingnst)
- [Karyakarsa](https://karyakarsa.com/gadingnst)
---
Feel free to contribute [simple-webstorage](https://github.com/sutanlab/simple-webstorage) 🙂
Copyright © 2019 by Sutan Gading Fadhillah Nasution