biskviit
Version:
Yet another module for http cookie handling
100 lines (63 loc) • 2 kB
Markdown
Yet another node module for handling http cookies. This module parses `Set-Cookie` header, stores the data to memory and returns valid value for `Cookie` header based on the stored cookie data.
> **NB** Requires Node.js v6+
Install from npm
npm install biskviit --save
Require as `Biskviit`
```javascript
const Biskviit = require('biskviit');
```
Create a cookie managing *biskviit* instance
```javascript
const biskviit = new Biskviit(options);
```
Where
* **options** is an optional options object with the following properties:
* **sessionTimeout** is the amount in seconds for default session length, used for cookies without an expire argument
**Example**
```javascript
const Biskviit = require('biskviit');
const biskviit = new Biskviit({
sessionTimeout: 5 * 60 // expire cookies after 5 minutes
});
```
To add new cookies to the storage use `set`
```javascript
biskviit.set(cookieString, url)
```
Where
* **cookieString** is the value from the `Set-Cookie:` header
* **url** is the currently open URL that sent the cookie header
**Example**
```javascript
biskviit.set('theme=light', 'http://example.com/');
biskviit.set('sessionToken=abc123; Expires=Wed, 09 Jun 2021 10:18:14 GMT', 'http://example.com/');
```
To list all available cookies for a specified URL use `get`
```javascript
const cookiesString = biskviit.get(url);
```
Where
* **url** is the URL the cookies are required for
**Example**
```javascript
const cookiesString = biskviit.get('http://example.com/');
// theme=light; sessionToken=abc123
```
If you need to filter cookies as objects, use `list`
```javascript
const cookiesString = biskviit.list(url);
```
Where
* **url** is the URL the cookies are required for
**Example**
```javascript
const cookiesString = biskviit.list('http://example.com/');
// [{key: 'theme', value: 'light', expires: ...}, {key: 'sessionToken', value: 'abc123', expires: ...}]
```
**MIT**