cookie-monster
v0.2.1
Published
Browserify-compatible module to get and set cookies in the browser
Downloads
1,620
Readme
cookie-monster
NOTE: cookie-monster is a fork of cookie-cutter by substack (James Halliday), which seems to have gone stale.
Set and get cookies in the browser or in node with document
.
In your browser code with browserify:
var cookie = require('cookie-monster');
var times = parseInt(cookie.getItem('times'), 10) || 0;
cookie.setItem('times', times + 1);
and times
will increment every time the page is reloaded.
methods
var cookie = require('cookie-monster');
cookie(document)
Return a new cookie object with .getItem()
, .setItem()
, .removeItem()
and .clear()
operating on document
. Older version's .get()
, .set()
and .remove()
methods are left for backward compatibility, but their usage is highly discouraged.
document.cookie
should be a non-referentially transparent setter/getter combo
like the DOM's variant where assignment with optional path and expiry creates a
new cookie in the getter as a key=value pair.
cookie.getItem(key)
Return the cookie value for key
. Aliased by cookie.get()
.
cookie.setItem(key, value, opts={})
Set the cookie at key
to value
with optional parameters expires
and path
. Aliased by cookie.set()
.
cookie.removeItem(key)
Removes cookie value stored at key
. Aliased by cookie.remove()
.
Alternatively you can use .setItem()
with { expires: new Date(0) }
option to unset a cookie.
cookie.clear()
Removes all currently available cookies.
install
With npm do:
npm install cookie-monster
test
With the console do
$ npm test
license
MIT/X11