HttpHeaders interface

  • Ссылка
Пакет:
@azure/core-rest-pipeline

Представляет набор заголовков 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 }

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

RawHttpHeaders

Сведения о наследуемом методе

[iterator]() 

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

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

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

унаследовано от Iterable.__@iterator@202