Блок предоставляет объект, содержащий набор методов для работы с cookie браузера (JS-свойство document.cookie).
| Имя | Тип возвращаемого значения | Описание |
|---|---|---|
get(name) |
String | null |
Служит для получения значения, хранящегося в cookie браузера. |
set(name, val, [options]) |
String |
Cлужит для записи cookie с заданным именем. |
Блок реализован в технологиях:
jsgetМетод служит для получения значения, хранящегося в cookie, для имени переданного аргументом.
Принимаемые аргументы:
| Аргумент | Тип | Описание |
|---|---|---|
name* |
String |
Имя cookie. |
* Обязательный аргумент.
Возвращает:
String — если cookie с заданным именем было установлено. Значение автоматически декодируется с помощью decodeURIComponent.null — если cookie с заданным именем отсутствует.Пример:
modules.require('cookie', function(cookie) {
cookie.set('mycookie', 'foobar');
console.log(cookie.get('mycookie')); // 'foobar'
console.log(cookie.get('foo')); // null
});
setМетод служит для записи cookie с заданным именем. Помимо имени и значения, методу можно передать хеш с дополнительными параметрами cookie.
Принимаемые аргументы:
| Аргумент | Тип | Описание |
|---|---|---|
name* |
String |
Имя cookie. |
val* |
String | null |
Значение cookie. При установке в качестве значения null cookie удаляется. |
[options] |
Object |
Опции. Свойства объекта: • expires (Number) – срок жизни cookie в сутках. При отрицательном значении cookie будет удалено. Альтернативно, можно передать в качестве значения сформированный объект даты (new Date()). • path (String) – путь от корня домена внутри которого будет доступно cookie. • domain (String) – домен. По умолчанию текущий домен. • secure (Boolean) – флаг, указывающий на необходимость использования с cookie шифрованного соединения SSL. По умолчанию false. |
* Обязательный аргумент.
Возвращает: объект this.
Пример:
modules.require('cookie', function(cookie) {
cookie.set('mycookie', 'foobar', {
expires : 1, // срок жизни одни сутки
path : '/', // доступно для всех страниц
secure : true // передавать cookie только по SSL
});
console.log(cookie.get('mycookie')); // 'foobar'
cookie.set('mycookie', null); // удаляем cookie
console.log(cookie.get('mycookie')); // null
});