CookieJar技术文档

1. 安装指南

在开始使用CookieJar之前，您需要先进行安装。安装过程非常简单，您只需使用npm命令即可完成。

npm install cookiejar

确保您的系统中已经安装了npm（Node.js包管理器）。如果没有，请先安装Node.js，它将自动包含npm。

2. 项目的使用说明

CookieJar是一个简单且健壮的cookies库。它提供了处理和存储cookie的功能，适用于Node.js环境。

主要功能

• 解析和生成cookie字符串
• 匹配cookie以确定它们是否可以访问
• 在多个域中正确地存储和检索多个cookie

快速开始

以下是一个简单的例子，展示了如何使用CookieJar来设置、获取和检查cookie。

const CookieJar = require('cookiejar');

// 创建一个新的CookieJar实例
const jar = new CookieJar();

// 设置一个cookie
jar.setCookie('name=value', 'example.com', '/');

// 获取一个cookie
const cookie = jar.getCookie('name', { domain: 'example.com', path: '/' });

// 检查cookie是否匹配
const isMatch = cookie.matches({ domain: 'example.com', path: '/' });

3. 项目API使用文档

下面是CookieJar库中的主要类和方法的使用文档。

CookieAccessInfo类

用于确定cookie匹配的质量。

属性

• String domain: 需要匹配的域。
• String path: 需要匹配的路径。
• Boolean secure: 访问是否安全（通常是ssl）。
• Boolean script: 访问是否来自脚本。

Cookie类

将输入转换为Cookie对象。

属性

• String name: cookie的名称。
• String value: 与cookie关联的字符串。
• String domain: 需要匹配的域（cookie中的.开头意味着通配符匹配以其余部分结尾的任何内容）。
• Boolean explicit_domain: 如果域名是通过cookie字符串明确设置的。
• String path: 基本路径匹配（与以/开头的任何路径匹配）。
• Boolean explicit_path: 如果路径是通过cookie字符串明确设置的。
• Boolean noscript: 如果应该将其保留在脚本之外。
• Boolean secure: 如果应该仅通过安全方式传输。
• Number expiration_date: 自1970年以来的毫秒数，在该时间后应移除cookie。

方法

• String toString(): 返回此cookie的set-cookie:字符串。
• String toValueString(): 返回此cookie的cookie:字符串。
• Cookie parse(cookiestr, request_domain, request_path): 将字符串解析到此cookie或如果直接调用则创建一个新的cookie。
• Boolean matches(access_info): 如果access_info允许检索此cookie，则返回true。
• Boolean collidesWith(cookie): 如果cookies不能在同一个空间中存在（域和路径匹配），则返回true。

CookieJar类

用于正确地持有来自多个域的多个cookie。

方法

• Cookie setCookie(cookie, request_domain, request_path): 修改（或添加，如果尚不存在）cookie到存储罐中。
• Cookie[] setCookies(cookiestr_or_list, request_domain, request_path): 修改（或添加，如果尚不存在）大量的cookie到存储罐中。
• Cookie getCookie(cookie_name, access_info): 根据名称和访问信息获取cookie。
• Cookie[] getCookies(access_info): 获取所有与访问信息匹配的cookie。

4. 项目安装方式

如前所述，您可以通过npm命令来安装CookieJar库。

npm install cookiejar

确保您的系统中已经安装了Node.js和npm。如果没有，请先从Node.js官网下载并安装Node.js。安装Node.js后，npm将自动安装，您就可以使用上述命令来安装CookieJar库了。