1Introduction
- description：浏览器核心 cookie
- author：ydr.me
- create：2016-04-08 22:45
- update：2016-04-08 22:45
- github：
https://github.com/blearjs/blear.core.cookie
2Example
var cookie = require('blear.core.cookie');
3Static
3.1.get(name): value
获取 cookie。
cookie.get('token');
// => "balabala"
3.1.1name
- 类型：
String - 说明：cookie 名称
3.1.2value
- 类型：
String - 说明：对应 cookie 值
3.2.getJSON(name): json
获取 cookie 的 JSON 值。
cookie.getJSON('userInfo');
// => {userName: 'Cloudcome'}
3.2.1name
- 类型：
String - 说明：cookie 名称
3.2.2json
- 类型：
Object | null - 说明：将对应cookie 值转换成 JSON 对象
3.3.set(name, value, [options]): cookieStr
设置 cookie。
cookie.set('token', 'balabala');
// => "token=balabala"
3.3.1name
- 类型：
String - 说明：cookie 名称
3.3.2value
- 类型：
String - 说明：cookie 值
3.3.3options
- 类型：
Object - 说明：配置
3.3.4options.domain
- 类型：
String - 说明：cookie 域
- 默认：自动设置，如果是
localhost，则为空；否则为location.hostname
3.3.5options.expires
- 类型：
Number - 说明：cookie 有效期，单位 ms
- 默认：
3600000
3.3.6options.path
- 类型：
String - 说明：cookie 路径
- 默认：
"/"
3.3.7options.secure
- 类型：
Boolean - 说明：是否以加密形式存取
- 默认：自动根据 URL 协议设置，如果是
https:则为true；否则为false
3.3.8cookieStr
- 类型：
String - 说明：实际设置的字符串表达式
3.4.setJSON(name, json, [options]): cookieStr
设置 cookie，存储的时候转换为 JSON。
cookie.set('userInfo', {
userName: 'cloudcome'
});
// => "userInfo={"userName":"cloudcome"}"
3.4.1name
- 类型：
String - 说明：cookie 名称
3.4.2json
- 类型：
Object - 说明：cookie 值
3.4.3options
- 类型：
Object - 说明：配置
3.4.4options.domain
- 类型：
String - 说明：cookie 域
- 默认：自动设置，如果是
localhost，则为空；否则为location.hostname
3.4.5options.expires
- 类型：
Number - 说明：cookie 有效期，单位 ms
- 默认：
3600000
3.4.6options.path
- 类型：
String - 说明：cookie 路径
- 默认：
"/"
3.4.7options.secure
- 类型：
Boolean - 说明：是否以加密形式存取
- 默认：自动根据 URL 协议设置，如果是
https:则为true；否则为false
3.4.8cookieStr
- 类型：
String - 说明：实际设置的字符串表达式
3.5.remove(name, [options]): cookieStr
移除 cookie。其实移除 cookie 本质上也是一种设置操作， 只是将 cookie 值设为空，有效期设置为过期。
cookie.remove('userInfo');
// => "userInfo=; expires=过期时间"
3.5.1name
- 类型：
String - 说明：cookie 名称
3.5.2json
- 类型：
Object - 说明：cookie 值
3.5.3options
- 类型：
Object - 说明：配置
3.5.4options.domain
- 类型：
String - 说明：cookie 域
- 默认：自动设置，如果是
localhost，则为空；否则为location.hostname
3.5.5options.path
- 类型：
String - 说明：cookie 路径
- 默认：
"/"
3.5.6options.secure
- 类型：
Boolean - 说明：是否以加密形式存取
- 默认：自动根据 URL 协议设置，如果是
https:则为true；否则为false
3.5.7cookieStr
- 类型：
String - 说明：实际设置的字符串表达式