browser-cookie

Standalone cookie class for the browser

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
browser-cookie
111.2.17 years ago8 years agoMinified + gzip package size for browser-cookie in KB

Readme

Table of Contents
Install Cookie
* [Options](#options)
* [Methods](#methods)
  * [cookie.set(key, value, [options])](#cookiesetkey-value-options)
  * [cookie.get(key, [value])](#cookiegetkey-value)
  * [cookie.del(key)](#cookiedelkey)
  * [cookie.clear(except, [options])](#cookieclearexcept-options)
Developer
* [Test](#test)
* [Start](#start)
* [Cover](#cover)
* [Lint](#lint)
* [Clean](#clean)
* [Spec](#spec)
* [Instrument](#instrument)
* [Readme](#readme)
License
Cookie
Stability: stable.

Standalone cookie implementation for the browser designed to work with browserify.
Derived from the jquery cookie plugin.

Install

npm i browser-cookie --save

Cookie

The Cookie class exposes the ability to get, set and delete cookie values.

Options

  • raw - Do not URI encode the cookie value.
  • json - Store the cookie value as JSON.
  • expires - Define lifetime of the cookie in days, default is 30.
  • path - Define the path where the cookie is valid, default is /.
  • domain - Define the domain whether the cookie is valid.
  • secure - If true, the cookie transmission requires a secure protocol (https).

Methods

cookie.set(key, value, options)

Sets a cookie value.

cookie.get(key, value)

Gets a cookie value. If the value parameter is specified it should be a conversion function, if no key is specified an object containing all key value pairs is returned.

cookie.del(key)

Deletes a cookie value.

cookie.clear(except, options)

Clear all cookies except the keys listed in the except array.

Developer

Developer workflow is via gulp but should be executed as npm scripts to enable shell execution where necessary.

Test

Run the headless test suite using phantomjs:
npm test

To run the tests in a browser context open test/index.html or use the server npm start.

Start

Serve the test files from a web server with:
npm start

Cover

Run the test suite and generate code coverage:
npm run cover

Lint

Run the source tree through eslint:
npm run lint

Clean

Remove generated files:
npm run clean

Spec

Compile the test specifications:
npm run spec

Instrument

Generate instrumented code from lib in instrument:
npm run instrument

Readme

Generate the project readme file (requires mdp):
npm run readme

License

Everything is MIT. Read the license if you feel inclined.
Generated by mdp(1).