Headers

Headers 对象提供了一组用于操作 HTTP 请求和响应头部的接口，其设计基于 Web API 标准的 Headers 接口。

构造函数

const headers = new Headers(init?);

参数：

参数名称	类型	必填	说明
init	object | Array<[string, string]> | Headers	否	初始化 Headers 对象。可以传入一个对象、一个包含键值对的数组，或另一个 Headers 对象进行初始化。

方法

append

headers.append(name: string, value: string): void;

在指定的头部字段上追加一个新值。如果该头部字段不存在，则直接添加。

参数：

属性名	类型	必填	说明
name	string	是	头部字段名称。
value	string	是	要追加的新值。

delete

headers.delete(name: string): void;

从 Headers 对象中删除指定的头部字段。

参数：

属性名	类型	必填	说明
name	string	是	头部字段名称。

entries

headers.entries(): IterableIterator<[string, string]>;

返回一个包含所有头部字段键值对的迭代器。

forEach

headers.forEach(callback: (value: string, name: string, headers: Headers) => void, thisArg?: any): void;

遍历 Headers 对象中的所有头部字段。

参数:

• callback: 针对每个头字段调用的函数，接收三个参数：

  • value: 头部字段的值。
  • name: 头部字段的名称。
  • headers: Headers 对象本身。

• thisArg (可选): 执行回调函数时用作 this 的值。

get

headers.get(name: string): string \| null;

从 Headers 对象中获取指定头部字段的值。如果该头部字段不存在，则返回 null。

getSetCookie

headers.getSetCookie(): Array<string>;

返回一个包含所有 Set-Cookie 头部字段值的数组。

has

headers.has(name: string): boolean;

判断 Headers 对象是否包含指定的头部字段。

keys

headers.keys(): IterableIterator<string>;

返回一个包含所有头部字段名称的迭代器。

set

headers.set(name: string, value: string): void;

设置指定头部字段的值。如果该头部字段不存在，则添加一个新的键值对。

values

headers.values(): IterableIterator<string>;

返回一个包含所有头部字段值的迭代器。

示例代码

function handleEvent(event) {
  // 创建一个 Headers 对象
  const headers = new Headers({
    'my-header-x': 'hello world',
  });

  // 创建一个 Response 对象，并设置 Headers
  const response =  new Response('hello world', {
    headers,
  });

  return response;
}

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

相关参考

• MDN Headers 文档