Compartilhar via

HttpHeaders class

  • Referência
Pacote:
@azure/ms-rest-js

Uma coleção de pares chave/valor de cabeçalho HTTP.

Construtores

HttpHeaders(RawHttpHeaders)

Métodos

clone()

Crie um clone/cópia profunda desta coleção HttpHeaders.
contains(string)

Obtenha se essa coleção de cabeçalho 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 para o nome de cabeçalho fornecido ou indefinido se nenhum cabeçalho existir nesta coleção com o nome fornecido.
headerNames()

Obtenha os nomes de cabeçalho contidos nesta coleção.
headersArray()

Obtenha os cabeçalhos contidos nesta coleção como uma matriz.
headerValues()

Obtenha os nomes de cabeçalho contidos nesta coleção.
rawHeaders()

Obtenha os cabeçalhos que contêm essa coleção como um objeto .
remove(string)

Remova o cabeçalho com o headerName fornecido. Retornar se o cabeçalho existe 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.
toJson()

Obtenha a representação de objeto JSON desta coleção de cabeçalhos HTTP.
toString()

Obtenha a representação de cadeia de caracteres desta coleção de cabeçalhos HTTP.

Detalhes do construtor

HttpHeaders(RawHttpHeaders) 

new HttpHeaders(rawHeaders?: RawHttpHeaders)

Parâmetros

rawHeaders
RawHttpHeaders

Detalhes do método

clone()

Crie um clone/cópia profunda desta coleção HttpHeaders.

function clone(): HttpHeaders

Retornos

HttpHeaders

contains(string)

Obtenha se essa coleção de cabeçalho 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

Retornos

boolean

get(string)

Obtenha o valor do cabeçalho para o nome de 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

HttpHeader[]

headerValues()

Obtenha os nomes 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

RawHttpHeaders

remove(string)

Remova o cabeçalho com o headerName fornecido. Retornar se o cabeçalho existe 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()

Obtenha a representação de objeto JSON desta coleção de cabeçalhos HTTP.

function toJson(): RawHttpHeaders

Retornos

RawHttpHeaders

toString()

Obtenha a representação de cadeia de caracteres desta coleção de cabeçalhos HTTP.

function toString(): string

Retornos

string