tasty-cookies

tasty-cookies

Table of contents

• Quick start
• Use in jQuery
• Use in CommonJS/Nodey
• API Reference
  • Cookie.set(key, value, [options])
  • Cookie.get(keys...)
  • Cookie.remove(keys...)
  • Cookie.keys()
  • Cookie.all()
  • Cookie.clear()

Quick start

• Install with Bower: bower install tasty-cookies
• Install with npm: npm install tasty-cookies

Use in jQuery

jQuery support! If you have connected jQuery you can use an alias $.cookie

$.cookie.set('my_cookie', 'Hello, World!');
$.cookie.get('my_cookie');
// -> 'Hello, World!'

Use in CommonJS/Node

In environments where there is no native window object, Cookie.js will export a factory method that accepts a window instance. For example, using jsdom, you might do something like:

var window = require('jsdom').jsdom().parentWindow;
var Cookie = require('cookie.js')(window);

API Reference

Methods

• Cookie.set(key, value, [options])
• Cookie.get(keys...)
• Cookie.remove(keys...)
• Cookie.keys()
• Cookie.all()
• Cookie.clear()

Example:

Cookie.set({
        string: 'Hello, World!',
        array: [1, 2, 3]
    })
    .set('object', {one: 1, two: 2});

console.log(Cookie.get('string'));
// -> 'Hello, World!'

Cookie.remove('string');

console.log(Cookie.get('string'));
// -> undefined
console.log(Cookie.get('array'));
// -> [1, 2, 3]
console.log(Cookie.get('object'));
// -> {one: 1, two: 2}

Cookie.set(key, value, [options])

Set cookies

Source

Arguments:

Name	Type	Description
key	String, Object	Cookie key
[value]	*	Cookie value
[options]	Object	Options for cookie Properties: Name Type Description [expires] Number Cookie expiration time [path] String Path for cookie [domain] String Domain for cookie [secure] Boolean Transfer cookies only over a secure connection.

Return: Cookie

Example:

Cookie.set('my_cookie', 5);
console.log(document.cookie)
// -> 'my_cookie=5'

// -- OR --

Cookie.set({
  one: 1,
  two: 2
});

console.log(document.cookie);
// -> 'one=1; two=2'

Cookie.get(keys...)

Getting cookies

Source

Arguments:

Name	Type	Description
keys...	String	Cookie keys

Return: *

Example:

Cookie.set('my_cookie', 5);
console.log(Cookie.get('my_cookie'));
// -> 5

Cookie.set('my_cookie', [1, 2, 3]);
console.log(Cookie.get('my_cookie'));
// -> [1, 2, 3]

Cookie.set({one: 1, two: 2});
console.log(Cookie.get('one', 'two'));
// -> {one: 1, two: 2}

Cookie.remove(keys...)

Remove cookies

Source

Arguments:

Name	Type	Description
keys...	String	Cookie keys

Return: Cookie

Example:

Cookie.set('my_cookie', 5);
console.log(document.cookie)
// -> 'my_cookie=5'

Cookie.remove('my_cookie')
console.log(document.cookie)
// -> ''

Cookie.set({one: 1, two: 2});
Cookie.remove('one', 'two');
console.log(document.cookie)
// -> ''

Cookie.keys()

Getting all keys cookies

Source

Return: Array

Example:

Cookie.set({
  one: 1,
  two: 2
});

console.log(Cookie.keys());
// -> ['one', 'two']

Cookie.all()

Getting all cookies

Source

Return: Object

Example:

Cookie.set({one: 1, two: 2});
console.log(Cookie.all());
// -> {one: 1, two: 2}

Cookie.clear()

Clear all cookies

Source

Return: Cookie

Example:

Cookie
  .set({one: 1, two: 2})
  .clear();
  
console.log(document.cookie);
// -> ''