HttpHeaders interface
Uma coleção de pares chave/valor de cabeçalho HTTP.
Métodos
clone() | Crie um clone/cópia profundo desta coleção httpHeaders. |
contains(string) | Obtenha se esta coleção de cabeçalhos contém ou não uma entrada de cabeçalho para o nome de cabeçalho fornecido. |
get(string) | Obtenha o valor do cabeçalho do nome de cabeçalho fornecido ou indefinido se não existir nenhum cabeçalho nesta coleção com o nome fornecido. |
header |
Obtenha os nomes de cabeçalho contidos nesta coleção. |
headers |
Obtenha os cabeçalhos contidos nesta coleção como uma matriz. |
header |
Obtenha os valores de cabeçalho contidos nesta coleção. |
raw |
Obtenha os cabeçalhos que contêm esta coleção como um objeto. |
remove(string) | Remova o cabeçalho com o headerName fornecido. Devolver se o cabeçalho existia ou não e foi removido. |
set(string, string | number) | Defina um cabeçalho nesta coleção com o nome e o valor fornecidos. O nome não é sensível a maiúsculas e minúsculas. |
to |
Obtenha a representação de objeto JSON desta coleção de cabeçalhos HTTP.
O resultado é o mesmo |
Detalhes de Método
clone()
Crie um clone/cópia profundo desta coleção httpHeaders.
function clone(): HttpHeadersLike
Devoluções
contains(string)
Obtenha se esta coleção de cabeçalhos contém ou não uma entrada de cabeçalho para o nome de cabeçalho fornecido.
function contains(headerName: string): boolean
Parâmetros
- headerName
-
string
Devoluções
boolean
get(string)
Obtenha o valor do cabeçalho do nome de cabeçalho fornecido ou indefinido se não existir nenhum cabeçalho nesta coleção com o nome fornecido.
function get(headerName: string): undefined | string
Parâmetros
- headerName
-
string
O nome do cabeçalho.
Devoluções
undefined | string
headerNames()
Obtenha os nomes de cabeçalho contidos nesta coleção.
function headerNames(): string[]
Devoluções
string[]
headersArray()
Obtenha os cabeçalhos contidos nesta coleção como uma matriz.
function headersArray(): HttpHeader[]
Devoluções
headerValues()
Obtenha os valores de cabeçalho contidos nesta coleção.
function headerValues(): string[]
Devoluções
string[]
rawHeaders()
Obtenha os cabeçalhos que contêm esta coleção como um objeto.
function rawHeaders(): RawHttpHeaders
Devoluções
remove(string)
Remova o cabeçalho com o headerName fornecido. Devolver se o cabeçalho existia ou não e foi removido.
function remove(headerName: string): boolean
Parâmetros
- headerName
-
string
O nome do cabeçalho a remover.
Devoluções
boolean
set(string, string | number)
Defina um cabeçalho nesta coleção com o nome e o valor fornecidos. O nome não é sensível a maiúsculas e minúsculas.
function set(headerName: string, headerValue: string | number)
Parâmetros
- headerName
-
string
O nome do cabeçalho a definir. Este valor não é sensível a maiúsculas e minúsculas.
- headerValue
-
string | number
O valor do cabeçalho a definir.
toJson({ preserveCase?: boolean })
Obtenha a representação de objeto JSON desta coleção de cabeçalhos HTTP.
O resultado é o mesmo rawHeaders()
que .
function toJson(options?: { preserveCase?: boolean }): RawHttpHeaders
Parâmetros
- options
-
{ preserveCase?: boolean }