HttpHeadersLike interface

Пакет:

@azure/ms-rest-js

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

Методы

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

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

clone()

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

function clone(): HttpHeadersLike

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

HttpHeadersLike

contains(string)

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

function contains(headerName: string): boolean

Параметры

headerName

string

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

boolean

get(string)

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

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)

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

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()

Получение представления объекта JSON этой коллекции заголовков HTTP. Результат совпадает с результатом rawHeaders().

function toJson(): RawHttpHeaders

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

RawHttpHeaders