Cookie

Cookie

cookie管理器
利用前端存储，模拟实现web中的cookie逻辑，详见[基础能力] cookie机制
注：目前仅支持基础的取值赋值操作，domain、path、expires等各种配置选项暂未支持，会予以忽略

Constructor

Source:

构造函数

Parameters:
Name Type Attributes Default Description
cookieStorageName string <optional>
 '__cookie'

cookie相关信息存储到storage时使用的key

Methods

(static) cookieObjToStr(cookieObj) → {string}

Source:

将{key1: value1, key2: value2}的对象形式键值对转为'key1=value1;key2=value2'形式的cookie字符串

Parameters:
Name Type Description
cookieObj Object
Returns:

cookieStr

Type
string

(static) cookieStrToObj(cookieStr) → {Object}

Source:

将'key1=value1;key2=value2'形式的cookie字符串转为{key1: value1, key2: value2}的对象形式

Parameters:
Name Type Description
cookieStr string
Returns:

cookieObj

Type
Object

(static) mergeCookieStr(…cookieStrs) → {string}

Source:

将'key1=value1;key2=value2'形式的cookie字符串合并，key相同时后面的覆盖前面的

Parameters:
Name Type Attributes Description
cookieStrs string <repeatable>

待合并的cookie字符串
Returns:

合并后的cookie字符串

Type
string

get(keyopt, optionsopt) → {string|object}

Source:

读取指定cookie
key未传时，返回全部cookie

Example
//假设当前环境所有cookie为：a=1;b=2;c=3
cookie.get('a'); //返回值：'1', cookie中存在指定key时，会返回其对应值
cookie.get('nonExist'); //返回值：'',  cookie中不存在指定key时，会返回空串
cookie.get(); //返回值：{a:'1', b:'2', c:'3'}，未传key时，会返回全部key-value组成的对象
Parameters:
Name Type Attributes Description
key string <optional>

要读取的key
options object <optional>

配置选项（暂未支持）
Returns:

cookie中key对应的value | 未传key时，返回全部key-value组成的对象

Type
string | object

getCookie() → {string}

Source:

获取当前可访问的cookie字符串

Returns:

cookie字符串，形如：'key1=value1;key2=value2'（类似web中读取document.cookie）

Type
string

set(key, value, optionsopt)

Source:

写入指定cookie

Parameters:
Name Type Attributes Description
key string

要写入的key
value string

要写入的value
options object <optional>

配置选项（暂未支持）

setCookie(setStr)

Source:

写入cookie

Parameters:
Name Type Description
setStr string

写入指令，格式形如：'key1=value1; path=/;'（类似web中document.cookie赋值）