Language: Russian, English
- Download the latest release
- Install with Bower:
bower install tasty-cookies - Install with npm:
npm install tasty-cookies
Full support (95.9% global browser share)
- Chrome 4+
- iOS Safari 4+
- UC Browser for Android 9.9+
- Firefox 3.5+
- Opera 10.5+
- Firefox for Android 32+
- Opera Mini 5+
- IE 8+
- Safari 4+
In environments where there is no native window object, tasty-cookies 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('tasty-cookies')(window);- Cookie.set(key, value, [options])
- Cookie.get(keys...)
- Cookie.remove(keys...)
- Cookie.keys()
- Cookie.all()
- Cookie.clear()
- Cookie.getLength()
- Cookie.noConflict()
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}Set cookies
Arguments:
| Name | Type | Description | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| key | String, Object | Cookie key | |||||||||||||||
| [value] | * | Cookie value | |||||||||||||||
| [options] | Object |
Options for cookie Properties:
|
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'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}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)
// -> ''Getting all keys cookies
Return: Array
Example:
Cookie.set({
one: 1,
two: 2
});
console.log(Cookie.keys());
// -> ['one', 'two']Getting all cookies
Return: Object
Example:
Cookie.set({one: 1, two: 2});
console.log(Cookie.all());
// -> {one: 1, two: 2}Clear all cookies
Return: Cookie
Example:
Cookie
.set({one: 1, two: 2})
.clear();
console.log(document.cookie);
// -> ''Getting length of all cookies
Example:
Cookie.set({one: 1, two: 2});
console.log(Cookie.getLength());
// -> 2Return: Number
Exemption name Cookie
Return: Cookie
Example:
var Cookie2 = Cookie.noConflict();
console.log(typeof Cookie2);
// -> 'function'
Cookie2.set('my_cookie', 5);
console.log(Cookie2.get('my_cookie'));
// -> 5