Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tada5hi/browser-storage-adapter
This is a library to save key-value pairs simultaneously to one or multiple storages (e.g. SessionStorage, LocalStorage, Cookie, ...).
https://github.com/tada5hi/browser-storage-adapter
browser cookie localstorage sessionstorage simultaneously
Last synced: about 2 months ago
JSON representation
This is a library to save key-value pairs simultaneously to one or multiple storages (e.g. SessionStorage, LocalStorage, Cookie, ...).
- Host: GitHub
- URL: https://github.com/tada5hi/browser-storage-adapter
- Owner: tada5hi
- License: mit
- Created: 2021-12-22T07:49:08.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-05-19T01:01:07.000Z (over 1 year ago)
- Last Synced: 2024-10-12T18:57:38.912Z (3 months ago)
- Topics: browser, cookie, localstorage, sessionstorage, simultaneously
- Language: TypeScript
- Homepage:
- Size: 1.04 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.MD
- Changelog: CHANGELOG.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Browser Storage Adapter 💾
[](https://badge.fury.io/js/browser-storage-adapter)
[](https://github.com/tada5hi/browser-storage-adapter/actions/workflows/main.yml)
[](https://snyk.io/test/github/Tada5hi/browser-storage-adapter?targetFile=package.json)
[](https://github.com/semantic-release/semantic-release)
This is a library to save key-value pairs to one or multiple storages (e.g. SessionStorage, LocalStorage, Cookie, ...).
**Table of Contents**
- [Installation](#installation)
- [Usage](#usage)
- [Options](#options)
## Installation
```bash
npm install browser-storage-adapter --save
```
## Usage
Create an instance of the `Adapter` and specify the `driver`s,
which should be enabled. By default, all drivers are disabled, expect of the in-memory driver, which is always enabled.
Besides, it is also possible to specify a custom `namespace`, so different instances of the Adapter don't interfere with each other, when they use the same key.
```typescript
import { Adapter } from 'browser-storage-adapter';
const warehouse = new Adapter({
driver: {
cookie: {
path: '/',
},
localStorage: true,
sessionStorage: true,
},
namespace: 'auth'
});
// Set a key-value pair for the following drivers:
// cookie, localStorage & sessionStorage.
warehouse.set('token', 'xxx');
// Ensure that value is still the same for all drivers.
warehouse.sync('token', 'xxx');
// Get a key-value pair.
const token = warehouse.get('token');
console.log(token);
// xxx
```
## Options
The Adapter accepts an `OptionsInput` object as input parameter, to modify the default behaviour.
````typescript
import { CookieSerializeOptions } from 'cookie';
declare type OptionsInput = {
/**
* Specify a key prefix.
* e.g.
* namespace: auth
* key: token
* keyWithNamespace: auth_token
*/
namespace?: string,
/**
* Enable or disable some available drivers.
*/
driver?: {
localStorage?: boolean,
sessionStorage?: boolean,
cookie?: boolean | CookieSerializeOptions
},
/**
* Check if the application is server rendered.
*/
isServer?: () => boolean,
/**
* Set cookie.
*
* @param key
* @param value
*/
setCookie?: (key: string, value: unknown) => void,
/**
* Get cookie.
*
* @param key
*/
getCookie?: (key: string) => unknown,
/**
* Append serialized cookie.
*
* @param value
*/
setServerCookie?: (value: string) => void,
/**
* Ger serialized cookie(s).
*/
getServerCookies?: () => string
}
````