HttpHeaders — Angular

Представляет параметры конфигурации заголовков HTTP-запроса. Экземпляры неизменяемы. Методы изменения возвращают клонированный экземпляр с внесёнными изменениями. Исходный объект никогда не изменяется.

API

class HttpHeaders {
  constructor(headers?: string | { [name: string]: string | number | (string | number)[]; } | Headers | undefined): HttpHeaders;
  has(name: string): boolean;
  get(name: string): string | null;
  keys(): string[];
  getAll(name: string): string[] | null;
  append(name: string, value: string | string[]): HttpHeaders;
  set(name: string, value: string | string[]): HttpHeaders;
  delete(name: string, value?: string | string[] | undefined): HttpHeaders;
}

constructor

HttpHeaders

Создаёт новый объект заголовков HTTP с указанными значениями.

@paramheadersstring | { [name: string]: string | number | (string | number)[]; } | Headers | undefined

@returnsHttpHeaders

has

boolean

Проверяет наличие указанного заголовка.

@paramnamestring

Имя заголовка, наличие которого нужно проверить.

@returnsboolean

True, если заголовок существует, иначе false.

get

string | null

Получает первое значение указанного заголовка.

@paramnamestring

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

@returnsstring | null

Строковое значение, если заголовок существует, иначе null

keys

string[]

Получает имена заголовков.

@returnsstring[]

Список имён заголовков.

getAll

string[] | null

Получает список значений указанного заголовка.

@paramnamestring

Имя заголовка, значения которого нужно получить.

@returnsstring[] | null

Строка со значениями, если заголовок существует, иначе null.

append

HttpHeaders

Добавляет новое значение к существующему набору значений заголовка и возвращает их в клоне исходного экземпляра.

@paramnamestring

Имя заголовка, к которому нужно добавить значения.

@paramvaluestring | string[]

Добавляемое значение.

@returnsHttpHeaders

Клон объекта заголовков HTTP с добавленным значением указанного заголовка.

set

HttpHeaders

Задаёт или изменяет значение указанного заголовка в клоне исходного экземпляра. Если заголовок уже существует, его значение в возвращаемом объекте заменяется указанным.

@paramnamestring

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

@paramvaluestring | string[]

Значение или значения, которые нужно задать или заменить для указанного заголовка.

@returnsHttpHeaders

Клон объекта заголовков HTTP с новым значением заголовка.

delete

HttpHeaders

Удаляет значения указанного заголовка в клоне исходного экземпляра.

@paramnamestring

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

@paramvaluestring | string[] | undefined

Значение или значения, которые нужно удалить для указанного заголовка.

@returnsHttpHeaders

Клон объекта заголовков HTTP с удалённым указанным значением.