HttpHeaders class

Пакет:

@azure/core-http

Коллекция пар ключей и значений заголовка HTTP.

Конструкторы

HttpHeaders(RawHttpHeaders)

Методы

clone()	Создайте глубокую клону или копию этой коллекции HttpHeaders.
contains(string)	Получите, содержит ли эта коллекция заголовков запись заголовка для указанного имени заголовка.
get(string)	Получите значение заголовка для указанного имени заголовка или не определено, если в этой коллекции нет заголовка с указанным именем.
headerNames()	Получите имена заголовков, содержащиеся в этой коллекции.
headersArray()	Получите заголовки, содержащиеся в этой коллекции в виде массива.
headerValues()	Получите значения заголовка, содержащиеся в этой коллекции.
rawHeaders()	Получите заголовки, содержащие эту коллекцию в качестве объекта.
remove(string)	Удалите заголовок с предоставленным заголовкомName. Возвращает значение, существует ли заголовок и удален.
set(string, string | number)	Задайте заголовок в этой коллекции с указанным именем и значением. Имя не учитывает регистр.
toJson({ preserveCase?: boolean })	Получите представление объекта JSON этой коллекции заголовков HTTP.
toString()	Получите строковое представление этой коллекции заголовков HTTP.

Сведения о конструкторе

HttpHeaders(RawHttpHeaders)

new HttpHeaders(rawHeaders?: RawHttpHeaders)

Параметры

rawHeaders

RawHttpHeaders

Сведения о методе

clone()

Создайте глубокую клону или копию этой коллекции HttpHeaders.

function clone(): HttpHeaders

Возвращаемое значение

HttpHeaders

contains(string)

Получите, содержит ли эта коллекция заголовков запись заголовка для указанного имени заголовка.

function contains(headerName: string): boolean

Параметры

headerName

string

Возвращаемое значение

boolean

get(string)

Получите значение заголовка для указанного имени заголовка или не определено, если в этой коллекции нет заголовка с указанным именем.

function get(headerName: string): undefined | string

Параметры

headerName

string

Имя заголовка.

Возвращаемое значение

undefined | string

headerNames()

Получите имена заголовков, содержащиеся в этой коллекции.

function headerNames(): string[]

Возвращаемое значение

string[]

headersArray()

Получите заголовки, содержащиеся в этой коллекции в виде массива.

function headersArray(): HttpHeader[]

Возвращаемое значение

HttpHeader[]

headerValues()

Получите значения заголовка, содержащиеся в этой коллекции.

function headerValues(): string[]

Возвращаемое значение

string[]

rawHeaders()

Получите заголовки, содержащие эту коллекцию в качестве объекта.

function rawHeaders(): RawHttpHeaders

Возвращаемое значение

RawHttpHeaders

remove(string)

Удалите заголовок с предоставленным заголовкомName. Возвращает значение, существует ли заголовок и удален.

function remove(headerName: string): boolean

Параметры

headerName

string

Имя удаляемого заголовка.

Возвращаемое значение

boolean

set(string, string | number)

Задайте заголовок в этой коллекции с указанным именем и значением. Имя не учитывает регистр.

function set(headerName: string, headerValue: string | number)

Параметры

headerName

string

Имя заданного заголовка. Это значение не учитывает регистр.

headerValue

string | number

Значение заданного заголовка.

toJson({ preserveCase?: boolean })

Получите представление объекта JSON этой коллекции заголовков HTTP.

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

Параметры

options

{ preserveCase?: boolean }

Возвращаемое значение

RawHttpHeaders

toString()

Получите строковое представление этой коллекции заголовков HTTP.

function toString(): string

Возвращаемое значение

string