HttpHeaders class

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 profundo desta coleção HttpHeaders.
contains(string)	Verifique se essa 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 para o nome do cabeçalho fornecido, ou undefined se não existir nenhum cabeçalho 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 contidos nesta 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.
toJson()	Obtenha a representação do 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 de Método

clone()

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

function clone(): HttpHeaders

Devoluções

HttpHeaders

contains(string)

Verifique se essa 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 para o nome do cabeçalho fornecido, ou undefined 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

HttpHeader[]

headerValues()

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

function headerValues(): string[]

Devoluções

string[]

rawHeaders()

Obtenha os cabeçalhos contidos nesta coleção como um objeto.

function rawHeaders(): RawHttpHeaders

Devoluções

RawHttpHeaders

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.

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 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 do objeto JSON desta coleção de cabeçalhos HTTP.

function toJson(): RawHttpHeaders

Devoluções

RawHttpHeaders

toString()

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

function toString(): string

Devoluções

string