97 lines
2.1 KiB
Markdown
97 lines
2.1 KiB
Markdown
|
|
||
|
|
|
||
|
|
cookie-storage: A Web Storage interface for Cookie.
|
||
|
|
|
||
|
|
[Storage interface spec](https://html.spec.whatwg.org/multipage/webstorage.html#the-storage-interface).
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
```
|
||
|
|
$ npm install cookie-storage
|
||
|
|
```
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
import { CookieStorage } from 'cookie-storage';
|
||
|
|
|
||
|
|
const cookieStorage = new CookieStorage();
|
||
|
|
|
||
|
|
cookieStorage.length === 0;
|
||
|
|
cookieStorage.getItem('key') === null;
|
||
|
|
|
||
|
|
cookieStorage.setItem('key', 'value');
|
||
|
|
cookieStorage.length === 1;
|
||
|
|
cookieStorage.key(0) === 'key';
|
||
|
|
|
||
|
|
cookieStorage.getItem('key') === 'value';
|
||
|
|
cookieStorage.removeItem('key');
|
||
|
|
cookieStorage.length === 0;
|
||
|
|
|
||
|
|
cookieStorage.setItem('k1', 'v1');
|
||
|
|
cookieStorage.setItem('k2', 'v2');
|
||
|
|
cookieStorage.length === 2;
|
||
|
|
|
||
|
|
cookieStorage.clear();
|
||
|
|
cookieStorage.length === 0;
|
||
|
|
|
||
|
|
// Cookie options
|
||
|
|
cookieStorage.setItem('key', 'value', {
|
||
|
|
path: '/',
|
||
|
|
domain: 'example.com',
|
||
|
|
expires: new Date(),
|
||
|
|
secure: true,
|
||
|
|
sameSite: 'Strict' // Can be 'Strict' or 'Lax'.
|
||
|
|
});
|
||
|
|
|
||
|
|
// Use default cookie options
|
||
|
|
const storage = new CookieStorage({
|
||
|
|
path: '/',
|
||
|
|
domain: 'example.com',
|
||
|
|
expires: new Date(),
|
||
|
|
secure: true,
|
||
|
|
sameSite: 'Strict' // Can be 'Strict' or 'Lax'.
|
||
|
|
});
|
||
|
|
storage.setItem('key', 'value'); // ;path=/;domain=example.com;...
|
||
|
|
```
|
||
|
|
|
||
|
|
## Development
|
||
|
|
|
||
|
|
```
|
||
|
|
$ npm install
|
||
|
|
$ npm run watch
|
||
|
|
```
|
||
|
|
|
||
|
|
## Badges
|
||
|
|
|
||
|
|
[![NPM][npm-badge]][npm]
|
||
|
|
[![Travis CI][travis-ci-badge]][travis-ci]
|
||
|
|
|
||
|
|
[npm]: https://www.npmjs.com/package/cookie-storage
|
||
|
|
[npm-badge]: https://img.shields.io/npm/v/cookie-storage.svg
|
||
|
|
[travis-ci]: https://travis-ci.org/bouzuya/cookie-storage
|
||
|
|
[travis-ci-badge]: https://img.shields.io/travis/bouzuya/cookie-storage.svg
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
[MIT](LICENSE)
|
||
|
|
|
||
|
|
## Related Project
|
||
|
|
|
||
|
|
- [bouzuya/simple-memory-storage][]
|
||
|
|
|
||
|
|
[bouzuya/simple-memory-storage]: https://github.com/bouzuya/simple-memory-storage
|
||
|
|
|
||
|
|
## Contributors
|
||
|
|
|
||
|
|
- [astegmaier (Andrew Stegmaier)](https://github.com/astegmaier)
|
||
|
|
- [nihakue (Gabriel West)](https://github.com/nihakue)
|
||
|
|
|
||
|
|
## Author
|
||
|
|
|
||
|
|
[bouzuya][user] <[m@bouzuya.net][email]> ([http://bouzuya.net][url])
|
||
|
|
|
||
|
|
[user]: https://github.com/bouzuya
|
||
|
|
[email]: mailto:m@bouzuya.net
|
||
|
|
[url]: http://bouzuya.net
|