有奖捉虫:办公协同&微信生态&物联网文档专题 HOT
Headers 基于 Web APIs 标准 Headers 进行设计。可用于 HTTP request 和 response 的头部操作。

构造函数

const headers = new Headers(init?: object | Array<[string, string]> | Headers);

参数

参数名称
类型
必填
说明
init
初始化 Headers 对象,参数类型说明如下:
object
构造函数将会枚举 Object 包含的所有可枚举属性,并初始化到新的 Headers 对象中。
Array<[string, string]>
数组的每一个元素为 key/value 的键值对(如:[key, value]),构造函数遍历数组,并初始化到新的 Headers 对象中。
Headers
拷贝 Headers 对象,并把所有字段初始化到新的 Headers 对象中。

方法

append

headers.append(name: string, value: string): void;
headers 对象指定的 header 上追加一个新值,若 header 不存在,则直接添加。

参数

属性名
类型
必填
说明
name
string
header 名
value
string
追加的新值

delete

headers.delete(name: string): void;
headers 对象中删除指定 header。

参数

属性名
类型
必填
说明
name
string
header 名

entries

headers.entries(): iterator;
获取 headers 对象所有的键值对([name, value])数组,返回值参考 MDN 官方文档:iterator

forEach

headers.forEach(callback: (value: string, name: string) => void | number): void;
遍历 headers 对象所有的 header。若 callback 返回非零值,表示终止遍历。
注意:
forEach 为非 Web APIs 标准方法。为了提供高效遍历 headers 的方式,边缘函数基于 Web APIs 标准进行了扩展实现。

get

headers.get(name: string): string;
headers 对象中获取指定 header 的值。

getSetCookie

headers.getSetCookie(): Array<string>
该方法返回一个数组,包含 Set-Cookie 头部的所有值。

has

headers.has(name: string): boolean;
判断 headers 对象是否包含该指定 header。

keys

headers.keys(): iterator;
获取 headers 对象包含的所有 key,返回值参考 MDN 官方文档:iterator

set

headers.set(name: string, value: string): void;
设置 headers 对象的指定 header 值,若该 header 不存在,则添加一个新的 key/value 键值对。

values

headers.values(): iterator;
获取 headers 对象包含的所有 value,返回值参考 MDN 官方文档:iterator

示例代码

function handleEvent() {
const headers = new Headers({
'my-header-x': 'hello world',
});

const response = new Response('hello world', {
headers,
});
return response;
}

addEventListener('fetch', (event) => {
event.respondWith(handleEvent(event));
});

相关参考