# fsys.cookies 库模块帮助文档

## fsys 成员列表 <a id="fsys" href="#fsys">&#x23;</a>

### fsys.cookies <a id="fsys.cookies" href="#fsys.cookies">&#x23;</a>
Netscape/cURL Cookie 文件格式解析器

### fsys.cookies() <a id="fsys.cookies" href="#fsys.cookies">&#x23;</a>
创建 Netscape /cURL Cookie 文件格式解析器  
此对象包含解析后的 Cookie 数组,并包含以域名为键的 Cookie 数组值,  

每个 Cookie 的字段含义如下：  
- domain  域名  
- flag 给定域的所有计算机是否可访问该值  
- path cookie路径  
- secure Cookie 是否仅适用于 HTTPS 连接  
- expires 过期时间,这是一个 time.gmt 对象,RFC1123 格式的时间值。会话 Cookie 这个字段的值为 null  
- name Cookie 的名字  
- value Cookie 的值  

[返回对象:fsyscookiesObject](#fsyscookiesObject)

## fsyscookiesObject 成员列表 <a id="fsyscookiesObject" href="#fsyscookiesObject">&#x23;</a>

### fsyscookiesObject.assign(_) <a id="fsyscookiesObject.assign" href="#fsyscookiesObject.assign">&#x23;</a>
混入兼容 Cookie 数组

### fsyscookiesObject.clear() <a id="fsyscookiesObject.clear" href="#fsyscookiesObject.clear">&#x23;</a>
清空已加载的全部 Cookie

### fsyscookiesObject.get() <a id="fsyscookiesObject.get" href="#fsyscookiesObject.get">&#x23;</a>
返回指定网址或域名的 Cookies,  
可用参数@1指定网址,也可以用参数 @1 指定域名，参数 @2 指定网站路径。  
不指定网站路径时默认为`/`

### fsyscookiesObject.getCookies() <a id="fsyscookiesObject.getCookies" href="#fsyscookiesObject.getCookies">&#x23;</a>
返回键值对组成的 Cookie  字符串,可用于 HTTP 请求头,失败返回 null,  
可用参数 @1 指定网址,也可以用参数@1指定域名,参数 @2 指定网站路径，  
不指定网站路径时默认为`/`

### fsyscookiesObject.header <a id="fsyscookiesObject.header" href="#fsyscookiesObject.header">&#x23;</a>
Cookie 文件头描述,一般不用指定

### fsyscookiesObject.load() <a id="fsyscookiesObject.load" href="#fsyscookiesObject.load">&#x23;</a>
自文件加载 Cookie ，参数指定类型  
此函数会清空之前加载的 Cookie

### fsyscookiesObject.parse() <a id="fsyscookiesObject.parse" href="#fsyscookiesObject.parse">&#x23;</a>
解析多行 Cookie  文本,参数指定字符串  
此函数会清空之前加载的 Cookie

### fsyscookiesObject.parseLine() <a id="fsyscookiesObject.parseLine" href="#fsyscookiesObject.parseLine">&#x23;</a>
解析一行 Cookie 文本,参数指定字符串.  
此函数 不会 清空之前加载的 Cookie

### fsyscookiesObject.push <a id="fsyscookiesObject.push" href="#fsyscookiesObject.push">&#x23;</a>
更新或添加 Cookie ,参数应当是一个表,  
如果指定域下已经存在同名Cookie ，则更新 Cookie   
否则添加 Cookie

### fsyscookiesObject.push(cookie) <a id="fsyscookiesObject.push" href="#fsyscookiesObject.push">&#x23;</a>

```aardio
fsyscookiesObject.push( {  
    domain = domain;  
    flag  = flag;  
    path = path;  
    secure = secure;  
    expires = ..time.gmt() ;  
    name = name;  
    value = value;  
    httpOnly = httpOnly;  
})
```

### fsyscookiesObject.save() <a id="fsyscookiesObject.save" href="#fsyscookiesObject.save">&#x23;</a>
保存到文件，参数指定文件路径

### fsyscookiesObject.stringify() <a id="fsyscookiesObject.stringify" href="#fsyscookiesObject.stringify">&#x23;</a>
所有 Cookie 转换为字符串

### fsyscookiesObject.stringifyLine() <a id="fsyscookiesObject.stringifyLine" href="#fsyscookiesObject.stringifyLine">&#x23;</a>
Cookie 转换为字符串，参数指定索引  
也可以直接传入一个 Cookie  对象

### fsyscookiesObject.stringifySetCookieLine() <a id="fsyscookiesObject.stringifySetCookieLine" href="#fsyscookiesObject.stringifySetCookieLine">&#x23;</a>
返回为 HTTP Set-Cookie 响应头格式字符串。  
参数指定索引，也可以直接传入一个 Cookie 对象。  
可选使用参数指定前缀，不指定时默认为`Set-Cookie: `。  
成功返回非空字符串
