Partilhar via

HttpHeaders interface

  • Referência
Pacote:
@azure/core-rest-pipeline

Representa um conjunto de cabeçalhos HTTP num pedido/resposta. Os nomes dos cabeçalhos são tratados como não sensíveis a maiúsculas e minúsculas.

Extends

Iterable<[string, string]>

Métodos

delete(string)

Remove um cabeçalho específico da coleção.
get(string)

Devolve o valor de um cabeçalho específico ou não definido se não estiver definido.
has(string)

Devolve verdadeiro se o cabeçalho especificado existir.
set(string, string | number | boolean)

Define um cabeçalho específico com um determinado valor.
toJSON({ preserveCase?: boolean })

Acede a um objeto JS não processado que atua como um mapa simples de nomes de cabeçalho para valores.

Métodos Herdados

[iterator]()

Detalhes de Método

delete(string)

Remove um cabeçalho específico da coleção.

function delete(name: string)

Parâmetros

name

string

O nome do cabeçalho a eliminar.

get(string)

Devolve o valor de um cabeçalho específico ou não definido se não estiver definido.

function get(name: string): undefined | string

Parâmetros

name

string

O nome do cabeçalho a obter.

Devoluções

undefined | string

has(string)

Devolve verdadeiro se o cabeçalho especificado existir.

function has(name: string): boolean

Parâmetros

name

string

O nome do cabeçalho a verificar.

Devoluções

boolean

set(string, string | number | boolean)

Define um cabeçalho específico com um determinado valor.

function set(name: string, value: string | number | boolean)

Parâmetros

name

string

O nome do cabeçalho a definir.

value

string | number | boolean

O valor a utilizar para o cabeçalho.

toJSON({ preserveCase?: boolean })

Acede a um objeto JS não processado que atua como um mapa simples de nomes de cabeçalho para valores.

function toJSON(options?: { preserveCase?: boolean }): RawHttpHeaders

Parâmetros

options

{ preserveCase?: boolean }

Devoluções

RawHttpHeaders

Detalhes do Método Herdado

[iterator]() 

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

Devoluções

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

Herdado de Iterable.__@iterator@130