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