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 legt einen neuen Wert für einen vorhandenen Header in einem Headers-Objekt fest oder fügt den Header hinzu, wenn er noch nicht existiert.

Der Unterschied zwischen set() und Headers.append besteht darin, dass, wenn der angegebene Header bereits existiert und mehrere Werte akzeptiert, set() den vorhandenen Wert mit dem neuen überschreibt, während Headers.append den neuen Wert an das Ende der Wertemenge anhängt.

Aus Sicherheitsgründen können einige Header nur vom Benutzeragenten gesteuert werden. Diese Header umfassen die verbotenen Header-Namen und verbotenen Antwort-Header-Namen.

Syntax

js
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, wirft diese Methode einen TypeError.

value

Der neue Wert, den Sie setzen möchten.

Rückgabewert

Keiner (undefined).

Beispiele

Das Erstellen eines leeren Headers-Objekts ist einfach:

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

Sie könnten diesem einen Header hinzufügen, indem Sie Headers.append verwenden, und dann einen neuen Wert für diesen Header mit set() festlegen:

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

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

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

Sie müssten Headers.append verwenden, um den neuen Wert an die Werte anzuhängen, ohne ihn zu überschreiben.

Spezifikationen

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

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch