Compartir a través de

HttpHeaders interface

  • Referencia
Paquete:
@azure/core-rest-pipeline

Representa un conjunto de encabezados HTTP en una solicitud o respuesta. Los nombres de encabezado se tratan como sin distinción entre mayúsculas y minúsculas.

Extends

Iterable<[string, string]>

Métodos

delete(string)

Quita un encabezado específico de la colección.
get(string)

Devuelve el valor de un encabezado específico o undefined si no se establece.
has(string)

Devuelve true si existe el encabezado especificado.
set(string, string | number | boolean)

Establece un encabezado específico con un valor determinado.
toJSON({ preserveCase?: boolean })

Obtiene acceso a un objeto JS sin formato que actúa como un mapa simple de los nombres de encabezado a los valores.

Métodos heredados

[iterator]()

Detalles del método

delete(string)

Quita un encabezado específico de la colección.

function delete(name: string)

Parámetros

name

string

Nombre del encabezado que se va a eliminar.

get(string)

Devuelve el valor de un encabezado específico o undefined si no se establece.

function get(name: string): undefined | string

Parámetros

name

string

Nombre del encabezado que se va a recuperar.

Devoluciones

undefined | string

has(string)

Devuelve true si existe el encabezado especificado.

function has(name: string): boolean

Parámetros

name

string

Nombre del encabezado que se va a comprobar.

Devoluciones

boolean

set(string, string | number | boolean)

Establece un encabezado específico con un valor determinado.

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

Parámetros

name

string

Nombre del encabezado que se va a establecer.

value

string | number | boolean

Valor que se va a usar para el encabezado.

toJSON({ preserveCase?: boolean })

Obtiene acceso a un objeto JS sin formato que actúa como un mapa simple de los nombres de encabezado a los valores.

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

Parámetros

options

{ preserveCase?: boolean }

Devoluciones

RawHttpHeaders

Detalles de los métodos heredados

[iterator]() 

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

Devoluciones

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

Heredado de Iterable.__@iterator@130