你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

HttpHeaders interface

表示请求/响应上的一组 HTTP 标头。 标头名称被视为不区分大小写。

Extends

Iterable<[string, string]>

方法

delete(string)

从集合中删除特定标头。

get(string)

返回特定标头的值,如果未设置,则返回未定义。

has(string)

如果指定的标头存在,则返回 true。

set(string, string | number | boolean)

设置具有给定值的特定标头。

toJSON({ preserveCase?: boolean })

访问一个原始 JS 对象,该对象充当标头名称到值的简单映射。

继承的方法

[iterator]()

方法详细信息

delete(string)

从集合中删除特定标头。

function delete(name: string)

参数

name

string

要删除的标头的名称。

get(string)

返回特定标头的值,如果未设置,则返回未定义。

function get(name: string): undefined | string

参数

name

string

要检索的标头的名称。

返回

undefined | string

has(string)

如果指定的标头存在,则返回 true。

function has(name: string): boolean

参数

name

string

要检查的标头的名称。

返回

boolean

set(string, string | number | boolean)

设置具有给定值的特定标头。

function set(name: string, value: string | number | boolean)

参数

name

string

要设置的标头名称。

value

string | number | boolean

要用于标头的值。

toJSON({ preserveCase?: boolean })

访问一个原始 JS 对象,该对象充当标头名称到值的简单映射。

function toJSON(options?: { preserveCase?: boolean }): RawHttpHeaders

参数

options

{ preserveCase?: boolean }

返回

继承的方法详细信息

[iterator]()

function [iterator](): Iterator<[string, string], any, undefined>

返回

Iterator<[string, string], any, undefined>

继承自 Iterable.__@iterator@130