1.0.1 • Published 8 years ago
tasty-cookies v1.0.1
tasty-cookies
Table of contents
Quick start
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
Arguments:
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
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
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
Return: Array
Example:
Cookie.set({
one: 1,
two: 2
});
console.log(Cookie.keys());
// -> ['one', 'two']
Cookie.all()
Getting all cookies
Return: Object
Example:
Cookie.set({one: 1, two: 2});
console.log(Cookie.all());
// -> {one: 1, two: 2}
Cookie.clear()
Clear all cookies
Return: Cookie
Example:
Cookie
.set({one: 1, two: 2})
.clear();
console.log(document.cookie);
// -> ''