HttpHeaders class

Paquete:

@azure/core-http

Colección de pares clave-valor de encabezado HTTP.

Constructores

HttpHeaders(RawHttpHeaders)

Métodos

clone()	Cree una copia o clonación profunda de esta colección HttpHeaders.
contains(string)	Obtenga si esta colección de encabezados contiene o no una entrada de encabezado para el nombre de encabezado proporcionado.
get(string)	Obtenga el valor de encabezado del nombre de encabezado proporcionado o undefined si no existe ningún encabezado en esta colección con el nombre proporcionado.
headerNames()	Obtenga los nombres de encabezado contenidos en esta colección.
headersArray()	Obtenga los encabezados contenidos en esta colección como una matriz.
headerValues()	Obtenga los valores de encabezado contenidos en esta colección.
rawHeaders()	Obtiene los encabezados contenidos en esta colección como un objeto .
remove(string)	Quite el encabezado con el headerName proporcionado. Devuelve si el encabezado existía o no y se quitó.
set(string, string | number)	Establezca un encabezado en esta colección con el nombre y el valor proporcionados. El nombre no distingue mayúsculas de minúsculas.
toJson({ preserveCase?: boolean })	Obtenga la representación del objeto JSON de esta colección de encabezados HTTP.
toString()	Obtiene la representación de cadena de esta colección de encabezados HTTP.

Detalles del constructor

HttpHeaders(RawHttpHeaders)

new HttpHeaders(rawHeaders?: RawHttpHeaders)

Parámetros

rawHeaders

RawHttpHeaders

Detalles del método

clone()

Cree una copia o clonación profunda de esta colección HttpHeaders.

function clone(): HttpHeaders

Devoluciones

HttpHeaders

contains(string)

Obtenga si esta colección de encabezados contiene o no una entrada de encabezado para el nombre de encabezado proporcionado.

function contains(headerName: string): boolean

Parámetros

headerName

string

Devoluciones

boolean

get(string)

Obtenga el valor de encabezado del nombre de encabezado proporcionado o undefined si no existe ningún encabezado en esta colección con el nombre proporcionado.

function get(headerName: string): undefined | string

Parámetros

headerName

string

Nombre del encabezado.

Devoluciones

undefined | string

headerNames()

Obtenga los nombres de encabezado contenidos en esta colección.

function headerNames(): string[]

Devoluciones

string[]

headersArray()

Obtenga los encabezados contenidos en esta colección como una matriz.

function headersArray(): HttpHeader[]

Devoluciones

HttpHeader[]

headerValues()

Obtenga los valores de encabezado contenidos en esta colección.

function headerValues(): string[]

Devoluciones

string[]

rawHeaders()

Obtiene los encabezados contenidos en esta colección como un objeto .

function rawHeaders(): RawHttpHeaders

Devoluciones

RawHttpHeaders

remove(string)

Quite el encabezado con el headerName proporcionado. Devuelve si el encabezado existía o no y se quitó.

function remove(headerName: string): boolean

Parámetros

headerName

string

Nombre del encabezado que se va a quitar.

Devoluciones

boolean

set(string, string | number)

Establezca un encabezado en esta colección con el nombre y el valor proporcionados. El nombre no distingue mayúsculas de minúsculas.

function set(headerName: string, headerValue: string | number)

Parámetros

headerName

string

Nombre del encabezado que se va a establecer. Este valor no distingue mayúsculas de minúsculas.

headerValue

string | number

Valor del encabezado que se va a establecer.

toJson({ preserveCase?: boolean })

Obtenga la representación del objeto JSON de esta colección de encabezados HTTP.

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

Parámetros

options

{ preserveCase?: boolean }

Devoluciones

RawHttpHeaders

toString()

Obtiene la representación de cadena de esta colección de encabezados HTTP.

function toString(): string

Devoluciones

string