HttpHeaders interface
Коллекция пар "ключ-значение" заголовка HTTP.
Методы
clone() | Создайте глубокий клон или копию этой коллекции HttpHeaders. |
contains(string) | Определяет, содержит ли эта коллекция заголовков запись заголовка для указанного имени заголовка. |
get(string) | Получите значение заголовка для указанного имени заголовка или значение undefined, если в этой коллекции не существует заголовка с указанным именем. |
header |
Получение имен заголовков, содержащихся в этой коллекции. |
headers |
Получение заголовков, содержащихся в этой коллекции, в виде массива. |
header |
Получение значений заголовков, содержащихся в этой коллекции. |
raw |
Получение заголовков, содержащих эту коллекцию в виде объекта . |
remove(string) | Удалите заголовок с указанным headerName. Возвращает значение, указывающее, существовал ли заголовок и был ли он удален. |
set(string, string | number) | Задайте заголовок в этой коллекции с указанными именем и значением. Имя не учитывает регистр. |
to |
Получение представления объекта JSON этой коллекции заголовков HTTP.
Результат совпадает с результатом |
Сведения о методе
clone()
Создайте глубокий клон или копию этой коллекции HttpHeaders.
function clone(): 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[]
Возвращаемое значение
headerValues()
Получение значений заголовков, содержащихся в этой коллекции.
function headerValues(): string[]
Возвращаемое значение
string[]
rawHeaders()
Получение заголовков, содержащих эту коллекцию в виде объекта .
function rawHeaders(): 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({ preserveCase?: boolean })
Получение представления объекта JSON этой коллекции заголовков HTTP.
Результат совпадает с результатом rawHeaders()
.
function toJson(options?: { preserveCase?: boolean }): RawHttpHeaders
Параметры
- options
-
{ preserveCase?: boolean }