HttpHeaders interface
Uma coleção de pares chave/valor de cabeçalho HTTP.
Métodos
clone() | Crie um clone/cópia profunda desta coleção HttpHeaders. |
contains(string) | Obtenha se essa coleção de cabeçalhos contém ou não uma entrada de cabeçalho para o nome do cabeçalho fornecido. |
get(string) | Obtenha o valor do cabeçalho para o nome do cabeçalho fornecido ou indefinido se nenhum cabeçalho existir 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 essa coleção como um objeto . |
remove(string) | Remova o cabeçalho com o headerName fornecido. Retorne 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 diferencia maiúsculas de minúsculas. |
to |
Obtenha a representação de objeto JSON desta coleção de cabeçalhos HTTP.
O resultado é o mesmo que |
Detalhes do método
clone()
Crie um clone/cópia profunda desta coleção HttpHeaders.
function clone(): HttpHeadersLike
Retornos
contains(string)
Obtenha se essa coleção de cabeçalhos contém ou não uma entrada de cabeçalho para o nome do cabeçalho fornecido.
function contains(headerName: string): boolean
Parâmetros
- headerName
-
string
Retornos
boolean
get(string)
Obtenha o valor do cabeçalho para o nome do cabeçalho fornecido ou indefinido se nenhum cabeçalho existir nesta coleção com o nome fornecido.
function get(headerName: string): undefined | string
Parâmetros
- headerName
-
string
O nome do cabeçalho.
Retornos
undefined | string
headerNames()
Obtenha os nomes de cabeçalho contidos nesta coleção.
function headerNames(): string[]
Retornos
string[]
headersArray()
Obtenha os cabeçalhos contidos nesta coleção como uma matriz.
function headersArray(): HttpHeader[]
Retornos
headerValues()
Obtenha os valores de cabeçalho contidos nesta coleção.
function headerValues(): string[]
Retornos
string[]
rawHeaders()
Obtenha os cabeçalhos que contêm essa coleção como um objeto .
function rawHeaders(): RawHttpHeaders
Retornos
remove(string)
Remova o cabeçalho com o headerName fornecido. Retorne 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 ser removido.
Retornos
boolean
set(string, string | number)
Defina um cabeçalho nesta coleção com o nome e o valor fornecidos. O nome não diferencia maiúsculas de minúsculas.
function set(headerName: string, headerValue: string | number)
Parâmetros
- headerName
-
string
O nome do cabeçalho a ser definido. Esse valor não diferencia maiúsculas de minúsculas.
- headerValue
-
string | number
O valor do cabeçalho a ser definido.
toJson({ preserveCase?: boolean })
Obtenha a representação de objeto JSON desta coleção de cabeçalhos HTTP.
O resultado é o mesmo que rawHeaders()
.
function toJson(options?: { preserveCase?: boolean }): RawHttpHeaders
Parâmetros
- options
-
{ preserveCase?: boolean }