【手册】jc-cookies 中文文档

jc-cookies 中文文档

1. 安装

npm

npm install jc-cookies

yarn

yarn add jc-cookies

2. 快速入门

2.1 创建 Cookie 实例

Cookie对象提供对浏览器中cookies进行增删改查的方法，您只需要导入它并创建其实例即可使用。

import { Cookie } from 'jc-cookies'
let storage = new Cookie()

2.2 查询现有cookie

2.2.1 查询整个cookie

（1） 以JavaScript 字符串 的形式返回

getter：cookie_string

示例：

import { Cookie } from 'jc-cookies'
let storage = new Cookie()
let s = storage.cookie_string

（2） 以 JavaScript 对象 的形式返回

getter：cookie_obj

示例：

import { Cookie } from 'jc-cookies'
let storage = new Cookie()
let s = storage.cookie_obj

【注】你将获得形如下图所示的对象，它包含cookie中的所有键值对。

（3） 以 JavaScript 映射（Map）的形式返回

你还可以将所有cookie取作Map返回。

getter：cookies

示例：

import { Cookie } from 'jc-cookies'
let storage = new Cookie()
let s = storage.cookies

【注】你将获得形如下图所示的映射（Map），它包含cookie中的所有键值对。

2.2.2 查询cookie指定键对应的值

（1）通过键查询值字符串

method：get(key)

示例：

const v = storag.get('key3')
console.log(v);

假设cookie中存储对应键key3的值为value3，则你将看到如下结果：

如果被查询的键不存在，可以看到错误提示。如指定一个不存在的键ke3：

const v = storag.get('ky3')
console.log(v);

可以看到结果不存在时会返回一个undefined作为值。

（2）将 Json字符串解析为 Javascript 对象返回

在之前的例子中，key4对应值的存储字符串{"a":0,"b":1,"c":2}就是可以解析为JavaScript对象的JSON字符串。在后面的 2.4.3 章节中你会看到，可以直接将一个JavaScript序列化为JSON字符串存储到Cookie中，当需要时再通过本方法还原为JavaScript对象，这两者是互为对应的。

method：get_json(key)

示例：

const obj = storage.get_json('key4')
console.log(obj);

如果该对字符串象存在，比如'{"a":0,"b":1,"c":2}'，则将看到形如下图的结果：

否则，可以看到错误提示。如指定一个不存在的键ke4：

console.log(storage.get_json('ke4'));

可以看到结果不存在时会返回一个undefined作为值，这与get(key)方法时一样的。

2.3 遍历 cookie

通过new Cookie()创所建的对象storage是可迭代的，也就是说你完全可以通过for...of...语句对cookie中的内容进行遍历。

示例：

for(const item of storage){
  console.log('item =',item);
}

你将看到形如下图所示的控制台打印结果：

2.4 写入 cookie

2.4.1 添加单个 cookie

你可以通过set方法添加单个 cookie ，并指定某些参数。除了key，value外，你还可以根据需要来指定expires、path、domain这些参数。其中expires参数既可以是一个表示时间的字符串，也可以是一个表示有效天数的数字。path参数默认为/，表示当前页面。

示例：

// 1天有效期
storage.set({key:'key0',value:'value0',expires:1})

2.4.2 添加多个 cookie

你还可以使用set_cookies()方法一次添加多个cookie键值对。

method：set_cookies(ary)

示例：

const ar:any[] = [
  {key:'a',value:'1'},
  {key:'b',value:'2'},
  {key:'c',value:'3'},
]
const v = storage.set_cookies(ar)

2.4.3 将一个字符串序列化为JSON字符串存储

这里，你可以很方便地将一个字符串序列话为JSON字符串进行存储。

method：set_json()

示例：

const obj = {key:"key5",value:{cn: 'Chinese', en: 'English'}}
storage.set_json()
console.log(storage.cookie_obj)

2.5 删除 cookie

2.5.1 删除某个 cookie 键值对

method：drop(key)

使用drop方法可以删除cookie中某个特定键名的键值对

示例：

drop('key1')

2.5.2 清理所有 cookie

method：clear()

该方法不需要其它参数，也没有返回值。它将清理所有cookie键值对。

示例：

clear()