HttpHeaders class

Paket:

@azure/core-http

Eine Auflistung von Schlüssel-Wert-Paaren im HTTP-Header.

Konstruktoren

HttpHeaders(RawHttpHeaders)

Methoden

clone()	Erstellen Sie einen tiefen Klon/eine Kopie dieser HttpHeaders-Auflistung.
contains(string)	Ruft ab, ob diese Headerauflistung einen Headereintrag für den angegebenen Headernamen enthält.
get(string)	Rufen Sie den Headerwert für den angegebenen Headernamen ab, oder nicht definiert, wenn in dieser Auflistung kein Header mit dem angegebenen Namen vorhanden ist.
headerNames()	Ruft die Headernamen ab, die in dieser Auflistung enthalten sind.
headersArray()	Rufen Sie die Header ab, die in dieser Auflistung enthalten sind, als Array.
headerValues()	Ruft die Headerwerte ab, die in dieser Auflistung enthalten sind.
rawHeaders()	Rufen Sie die Header ab, die in dieser Auflistung enthalten sind, als Objekt.
remove(string)	Entfernen Sie den Header mit dem bereitgestellten headerName. Gibt zurück, ob der Header vorhanden und entfernt wurde.
set(string, string | number)	Legen Sie einen Header in dieser Auflistung mit dem angegebenen Namen und Wert fest. Beim Namen wird die Groß-/Kleinschreibung nicht berücksichtigt.
toJson({ preserveCase?: boolean })	Rufen Sie die JSON-Objektdarstellung dieser HTTP-Headerauflistung ab.
toString()	Ruft die Zeichenfolgendarstellung dieser HTTP-Headerauflistung ab.

Details zum Konstruktor

HttpHeaders(RawHttpHeaders)

new HttpHeaders(rawHeaders?: RawHttpHeaders)

Parameter

rawHeaders

RawHttpHeaders

Details zur Methode

clone()

Erstellen Sie einen tiefen Klon/eine Kopie dieser HttpHeaders-Auflistung.

function clone(): HttpHeaders

Gibt zurück

HttpHeaders

contains(string)

Ruft ab, ob diese Headerauflistung einen Headereintrag für den angegebenen Headernamen enthält.

function contains(headerName: string): boolean

Parameter

headerName

string

Gibt zurück

boolean

get(string)

Rufen Sie den Headerwert für den angegebenen Headernamen ab, oder nicht definiert, wenn in dieser Auflistung kein Header mit dem angegebenen Namen vorhanden ist.

function get(headerName: string): undefined | string

Parameter

headerName

string

Der Name des Headers.

Gibt zurück

undefined | string

headerNames()

Ruft die Headernamen ab, die in dieser Auflistung enthalten sind.

function headerNames(): string[]

Gibt zurück

string[]

headersArray()

Rufen Sie die Header ab, die in dieser Auflistung enthalten sind, als Array.

function headersArray(): HttpHeader[]

Gibt zurück

HttpHeader[]

headerValues()

Ruft die Headerwerte ab, die in dieser Auflistung enthalten sind.

function headerValues(): string[]

Gibt zurück

string[]

rawHeaders()

Rufen Sie die Header ab, die in dieser Auflistung enthalten sind, als Objekt.

function rawHeaders(): RawHttpHeaders

Gibt zurück

RawHttpHeaders

remove(string)

Entfernen Sie den Header mit dem bereitgestellten headerName. Gibt zurück, ob der Header vorhanden und entfernt wurde.

function remove(headerName: string): boolean

Parameter

headerName

string

Der Name des zu entfernenden Headers.

Gibt zurück

boolean

set(string, string | number)

Legen Sie einen Header in dieser Auflistung mit dem angegebenen Namen und Wert fest. Beim Namen wird die Groß-/Kleinschreibung nicht berücksichtigt.

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

Parameter

headerName

string

Der Name des festzulegenden Headers. Bei diesem Wert wird die Groß-/Kleinschreibung nicht beachtet.

headerValue

string | number

Der Wert des festzulegenden Headers.

toJson({ preserveCase?: boolean })

Rufen Sie die JSON-Objektdarstellung dieser HTTP-Headerauflistung ab.

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

Parameter

options

{ preserveCase?: boolean }

Gibt zurück

RawHttpHeaders

toString()

Ruft die Zeichenfolgendarstellung dieser HTTP-Headerauflistung ab.

function toString(): string

Gibt zurück

string