HttpHeaders interface

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

Representa um conjunto de cabeçalhos HTTP em uma solicitação/resposta. Os nomes de cabeçalho são tratados como insensí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)

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

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

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

Acessa um objeto JS bruto 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 ser excluído.

get(string)

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

function get(name: string): undefined | string

Parâmetros

name

string

O nome do cabeçalho a ser recuperado.

Devoluções

undefined | string

has(string)

Retorna true se o cabeçalho especificado existir.

function has(name: string): boolean

Parâmetros

name

string

O nome do cabeçalho a ser verificado.

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 ser definido.

value

string | number | boolean

O valor a ser usado para o cabeçalho.

toJSON({ preserveCase?: boolean })

Acessa um objeto JS bruto 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>

herdada de Iterable.__@iterator@202