README

安装

直接通过 script 引入：

<script src="https://unpkg.com/cookie-ctrl@0.0.3/dist/cookie-ctrl.js"></script>

这时会创建一个全局函数cookies。

通过 npm 安装：

npm i -S cookie-ctrl

引入：

const cookies = require('cookie-ctrl');

或者使用 ES2015 Module 语法引入：

import cookies from 'cookie-ctrl';

设置一条 cookie

// 第二个参数可以省略。
// 未设置的属性将使用缺省值，具体见下面的[设置缺省值]。
cookies.set({token: 123}, {
  maxAge: 3600
});

设置多条 cookies

// 同样第二个参数可以省略
cookies.set([{token1: 123}, {token2: 123}], {
  path: '/subpath'
});
// 还可以对各个 cookie 对设置不同的属性，将cookie 与自定义的属性打包为一个数组即可，缺省的属性将由第二个参数填充，如果第二个参数为空，则使用默认属性
cookies.set([
  [{token1: 123}, {
    maxAge: 3600
  }],
  {token2: 321}
], {
  path: '/subpath'
});

读取 cookie

cookies.get() 如果找到对应的值将返回一个对象，这个对象有三个属性；如果没有找到对应的值，返回 false。

返回对象的三个值：

key {String} 要查找的 key 值
value {String} 对应的 value 值
isSetByCookies {boolean} 如果要查找的 cookie 是通过 cookie-ctrl 设置，则返回 true

cookies.get('token');

删除一条 cookie

cookies.del('token')

删除多条 cookies

cookies.del(['token1', 'token2'])

设置缺省 cookie 属性

如果设置一条 cookie 没有传入相对的属性，那么 cookie-ctrl 会使用默认的属性值：

expires: ''
max-age: 365 * 24 * 3600
domain: ''
path: '/'

可以通过修改 cookies 上对应的属性修改缺省值：

// expires 的值必须是 Date 实例或为可被 Date.parse() 解析的字符串
cookies.expires = new Date.toUTCString();

// 所有现代浏览器中设置了 max-age，就会忽略 expires
cookies.maxAge = 24 * 3600;

// 设置 domain，默认为当前域名
cookies.domain = '.example.com';

// 设置 path，默认为根路径
cookies.path = '/subpath';

// 设置 secure，如果当前网页为 https 协议，则默认值为 true
cookies.secure = false;

注意

cookie-ctrl删除和修改的 cookie 只能限定于通过cookie-ctrl设置的 cookie。因为修改一条 cookie 必须要达到 key、domain、path、secure 属性完全匹配才可以，而 JavaScript 没办法读取到这些属性，所以cookie-ctrl无法保证通过服务器端和用户自己创建 document.cookie 设置的 cookie 进行操作。

cookie-ctrl 无法完成的操作

未通过 cookie-ctrl 设置的 cookie 将不能通过 cookie-ctrl 修改，并给出警告
通过 cookie-ctrl 设置的 cookie 再次修改时，只能修改 expires maxAge，如果修改其它属性，cookie-ctrl 将忽略这些属性的修改并给出警告。

Usage no npm install needed!