keks
get, set and remove cookies
Installation
npm
$ npm install keks
bower
$ bower install keks
manual
API
keks.get( [name] )
Get one or all cookies.
@param String name@return String|Object
Examples
Get the value of 'cookie_name'.
keks;// => cookie_value keks;// => undefined
Get an Object with all cookies as key/value pair
keks;// => { "cookie_name": "cookie_value", "another_cookie": "another_value", ... }
keks.set( name, value, [options] )
Set cookie.
@param String name@param String|Number value@param Object options
Examples
Create/set the value of 'cookie_name'. If no options are set, it will default to a session cookie.
keks;// => true
Create/set a cookie expiring 48 hours from now.
keks;// => true
Create/set a cookie expiring at a given date.
keks;// => true
keks.remove( name )
Removes cookie.
@param String name@return Boolean
Example
remove a cookie.
keks;// => true
When deleting a cookie, the path, domain and secure option must match the options that were used to create the cookie.
keks;// => true
options
An Object
can be passed to keks.set() in order to change the cookie properties.
expires
Set the lifetime of the cookie.
If the value of expires is a Number
, the expiration date is value hours from the time of creation.
expires: 48
You can also pass a Date
object
expires: 20160331
If omitted, the cookie will default to a session cookie
domain
Set the domain where the cookie is valid.
domain: '.example.com'
If omitted, the domain will default to the page where the cookie was created.
path
Set the path where the cookie is valid.
path: '/'
If omitted, the path will default to the path of the page where the cookie was created.
secure
Set whether the cookie requires https to be transmitted.
secure: true
If omitted, it will default to false.
License
MIT