Headers

Konstruktor

Headers()

Erstellt ein neues Headers-Objekt.

Instanzmethoden

Headers.append()

Hängt einen neuen Wert an einen vorhandenen Header in einem Headers-Objekt an oder fügt den Header hinzu, falls er noch nicht vorhanden ist.

Headers.delete()

Löscht einen Header aus einem Headers-Objekt.

Headers.entries()

Gibt einen iterator zurück, mit dem Sie alle in diesem Objekt enthaltenen Schlüssel-Wert-Paare durchlaufen können.

Headers.forEach()

Führt eine bereitgestellte Funktion einmal für jedes Schlüssel-Wert-Paar in diesem Headers-Objekt aus.

Headers.get()

Gibt eine String-Zeichenfolge mit allen Werten eines Headers mit dem angegebenen Namen innerhalb eines Headers-Objekts zurück.

Headers.getSetCookie()

Gibt ein Array mit den Werten aller einer Response zugeordneten Set-Cookie-Header zurück.

Headers.has()

Gibt einen booleschen Wert zurück, der angibt, ob ein Headers-Objekt einen bestimmten Header enthält.

Headers.keys()

Gibt einen iterator zurück, mit dem Sie alle Schlüssel der in diesem Objekt enthaltenen Schlüssel-Wert-Paare durchlaufen können.

Headers.set()

Setzt einen neuen Wert für einen vorhandenen Header in einem Headers-Objekt oder fügt den Header hinzu, falls er noch nicht vorhanden ist.

Headers.values()

Gibt einen iterator zurück, mit dem Sie alle Werte der in diesem Objekt enthaltenen Schlüssel-Wert-Paare durchlaufen können.

Beschreibung

Ein Headers-Objekt besitzt eine zugehörige Header-Liste, die anfangs leer ist und aus null oder mehr Name-Wert-Paaren besteht. Sie können dieser Liste mit Methoden wie append() Einträge hinzufügen (siehe Beispiele). Bei allen Methoden dieser Schnittstelle werden Header-Namen anhand einer Bytefolge verglichen, ohne zwischen Groß- und Kleinschreibung zu unterscheiden.

Ein Objekt, das Headers implementiert, kann direkt in einer for...of-Struktur statt mit entries() verwendet werden: for (const p of myHeaders) entspricht for (const p of myHeaders.entries()).

Einschränkungen bei Änderungen

Bei einigen Headers-Objekten ist eingeschränkt, ob die Methoden set(), delete() und append() die Header verändern dürfen. Welche Einschränkungen gelten, hängt davon ab, wie das Headers-Objekt erstellt wurde:

• Für Header, die mit dem Konstruktor Headers() erstellt wurden, gelten keine Einschränkungen bei Änderungen.
• Für Header von Request-Objekten:
  • Wenn der mode des Requests no-cors ist, können Sie Namen und Werte aller CORS-safelisted request header ändern.
  • Andernfalls können Sie Namen und Werte aller nicht verbotenen Request-Header ändern.
• Für Header von Response-Objekten:
  • Wenn die Response mit Response.error() oder Response.redirect() erstellt oder von einem Aufruf von fetch() empfangen wurde, sind die Header unveränderlich.
  • Wenn die Response dagegen mit Response() oder Response.json() erstellt wurde, können Sie Namen und Werte aller nicht verbotenen Response-Header ändern.
• Header, die von der Eigenschaft WebTransport.responseHeaders zurückgegeben werden, sind unveränderlich.

Alle Headers-Methoden lösen einen TypeError aus, wenn Sie einen Namen übergeben, der kein gültiger HTTP-Header-Name ist. Änderungsoperationen lösen einen TypeError aus, wenn der Header unveränderlich ist. In allen anderen Fehlerfällen schlagen sie ohne Fehlermeldung fehl.

Beispiele

Im folgenden Ausschnitt erstellen wir mit dem Konstruktor Headers() ein neues Headers-Objekt, fügen ihm mit append() einen Header hinzu und rufen dessen Wert anschließend mit get() ab:

const myHeaders = new Headers();

myHeaders.append("Content-Type", "text/xml");
myHeaders.get("Content-Type"); // should return 'text/xml'

Dasselbe lässt sich erreichen, indem Sie dem Konstruktor ein Array aus Arrays oder ein Objektliteral übergeben:

let myHeaders = new Headers({
  "Content-Type": "text/xml",
});

// or, using an array of arrays:
myHeaders = new Headers([["Content-Type", "text/xml"]]);

myHeaders.get("Content-Type"); // should return 'text/xml'

Spezifikationen

Browser-Kompatibilität

Siehe auch

• ServiceWorker API
• HTTP-Zugriffskontrolle (CORS)
• HTTP