Headers: set()-Methode

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since March 2017.

Hinweis: Diese Funktion ist in Web Workers verfügbar.

Die set()-Methode der Headers-Schnittstelle setzt einen neuen Wert für einen bestehenden Header innerhalb eines Headers-Objekts oder fügt den Header hinzu, falls dieser noch nicht existiert.

Der Unterschied zwischen set() und Headers.append besteht darin, dass set() den bestehenden Wert durch den neuen ersetzt, wenn der angegebene Header bereits existiert und mehrere Werte akzeptiert, während Headers.append den neuen Wert am Ende der Wertemenge anhängt.

Aus Sicherheitsgründen können einige Header nur vom Benutzeragenten kontrolliert werden. Diese Header umfassen die verbotenen Anforderungsheader und verbotenen Antwortheadernamen.

Syntax

set(name, value)

Parameter

name: Der Name des HTTP-Headers, den Sie auf einen neuen Wert setzen möchten. Wenn der angegebene Name nicht der Name eines HTTP-Headers ist, löst diese Methode einen TypeError aus.
value: Der neue Wert, den Sie setzen möchten.

Rückgabewert

Keiner (undefined).

Beispiele

Ein leeres Headers-Objekt zu erstellen, ist einfach:

const myHeaders = new Headers(); // Currently empty

Sie können diesem mit Headers.append einen Header hinzufügen und dann mit set() einen neuen Wert für diesen Header setzen:

myHeaders.append("Content-Type", "image/jpeg");
myHeaders.set("Content-Type", "text/html");

Falls der angegebene Header noch nicht existiert, erstellt set() ihn und setzt seinen Wert auf den angegebenen Wert. Falls der angegebene Header bereits existiert und mehrere Werte akzeptiert, überschreibt set() den bestehenden Wert mit dem neuen Wert:

myHeaders.set("Accept-Encoding", "deflate");
myHeaders.set("Accept-Encoding", "gzip");
myHeaders.get("Accept-Encoding"); // Returns 'gzip'

Um den neuen Wert zu den bestehenden Werten hinzuzufügen, ohne sie zu überschreiben, benötigen Sie Headers.append.

Spezifikationen

Specification
Fetch # ref-for-dom-headers-set①