Partager via

HttpHeaders class

  • Référence
Paquet:
@azure/core-http

Collection de paires clé/valeur d’en-tête HTTP.

Constructeurs

HttpHeaders(RawHttpHeaders)

Méthodes

clone()

Créez un clone/copie profond de cette collection HttpHeaders.
contains(string)

Déterminez si cette collection d’en-têtes contient ou non une entrée d’en-tête pour le nom d’en-tête fourni.
get(string)

Obtenez la valeur d’en-tête pour le nom d’en-tête fourni, ou non défini si aucun en-tête n’existe dans cette collection avec le nom fourni.
headerNames()

Obtenez les noms d’en-tête contenus dans cette collection.
headersArray()

Obtenez les en-têtes contenus dans cette collection sous forme de tableau.
headerValues()

Obtenez les valeurs d’en-tête contenues dans cette collection.
rawHeaders()

Obtenez les en-têtes contenus dans cette collection en tant qu’objet.
remove(string)

Supprimez l’en-tête avec le nom d’en-tête fourni. Retourne si l’en-tête a existé et a été supprimé.
set(string, string | number)

Définissez un en-tête dans cette collection avec le nom et la valeur fournis. Le nom ne respecte pas la casse.
toJson({ preserveCase?: boolean })

Obtenez la représentation d’objet JSON de cette collection d’en-têtes HTTP.
toString()

Obtenez la représentation sous forme de chaîne de cette collection d’en-têtes HTTP.

Détails du constructeur

HttpHeaders(RawHttpHeaders) 

new HttpHeaders(rawHeaders?: RawHttpHeaders)

Paramètres

rawHeaders
RawHttpHeaders

Détails de la méthode

clone()

Créez un clone/copie profond de cette collection HttpHeaders.

function clone(): HttpHeaders

Retours

HttpHeaders

contains(string)

Déterminez si cette collection d’en-têtes contient ou non une entrée d’en-tête pour le nom d’en-tête fourni.

function contains(headerName: string): boolean

Paramètres

headerName

string

Retours

boolean

get(string)

Obtenez la valeur d’en-tête pour le nom d’en-tête fourni, ou non défini si aucun en-tête n’existe dans cette collection avec le nom fourni.

function get(headerName: string): undefined | string

Paramètres

headerName

string

Nom de l'en-tête.

Retours

undefined | string

headerNames()

Obtenez les noms d’en-tête contenus dans cette collection.

function headerNames(): string[]

Retours

string[]

headersArray()

Obtenez les en-têtes contenus dans cette collection sous forme de tableau.

function headersArray(): HttpHeader[]

Retours

HttpHeader[]

headerValues()

Obtenez les valeurs d’en-tête contenues dans cette collection.

function headerValues(): string[]

Retours

string[]

rawHeaders()

Obtenez les en-têtes contenus dans cette collection en tant qu’objet.

function rawHeaders(): RawHttpHeaders

Retours

RawHttpHeaders

remove(string)

Supprimez l’en-tête avec le nom d’en-tête fourni. Retourne si l’en-tête a existé et a été supprimé.

function remove(headerName: string): boolean

Paramètres

headerName

string

Nom de l’en-tête à supprimer.

Retours

boolean

set(string, string | number)

Définissez un en-tête dans cette collection avec le nom et la valeur fournis. Le nom ne respecte pas la casse.

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

Paramètres

headerName

string

Nom de l'en-tête à définir. Cette valeur ne respecte pas la casse.

headerValue

string | number

Valeur de l’en-tête à définir.

toJson({ preserveCase?: boolean })

Obtenez la représentation d’objet JSON de cette collection d’en-têtes HTTP.

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

Paramètres

options

{ preserveCase?: boolean }

Retours

RawHttpHeaders

toString()

Obtenez la représentation sous forme de chaîne de cette collection d’en-têtes HTTP.

function toString(): string

Retours

string