Request
Baseline
Weitgehend verfügbar
*
Diese Funktion ist gut etabliert und funktioniert auf vielen Geräten und in vielen Browserversionen. Sie ist seit März 2017 browserübergreifend verfügbar.
* Einige Teile dieser Funktion werden möglicherweise unterschiedlich gut unterstützt.
Hinweis: Diese Funktion ist in Web Workers verfügbar.
Das Request-Interface der Fetch API repräsentiert eine Ressourcenanfrage.
Sie können ein neues Request-Objekt mit dem Request()-Konstruktor erstellen, aber es ist wahrscheinlicher, dass Sie auf ein Request-Objekt stoßen, das als Ergebnis einer anderen API-Operation zurückgegeben wird, wie z.B. ein Service-Worker-Objekt FetchEvent.request.
Konstruktor
Request()-
Erstellt ein neues
Request-Objekt.
Instanz-Eigenschaften
Request.bodySchreibgeschützt-
Ein
ReadableStreamdes Inhalts des Bodys. Request.bodyUsedSchreibgeschützt-
Speichert
trueoderfalse, um anzuzeigen, ob der Body in einer Anfrage bereits verwendet wurde oder nicht. Request.cacheSchreibgeschützt-
Enthält den Cache-Modus der Anfrage (z.B.
default,reload,no-cache). Request.credentialsSchreibgeschützt-
Enthält einen Wert, der steuert, ob Anmeldeinformationen mit der Anfrage einbezogen werden sollen (z.B.
omit,same-origin,include). Der Standardwert istsame-origin. Request.destinationSchreibgeschützt-
Ein String, der den Typ des angeforderten Inhalts beschreibt.
Request.duplexSchreibgeschützt-
Der Duplex-Modus der Anfrage, der bestimmt, ob der Browser die gesamte Anfrage senden muss, bevor die Antwort verarbeitet wird.
Request.headersSchreibgeschützt-
Enthält das zugehörige
Headers-Objekt der Anfrage. Request.integritySchreibgeschützt-
Enthält den Subresource Integrity-Wert der Anfrage (z.B.
sha256-BpfBw7ivV8q2jLiT13fxDYAe2tJllusRSZ273h2nFSE=). -
Ein Boolean, der angibt, ob die Anfrage eine Verlaufnavigation ist.
-
Ein Boolean, der angibt, ob die Anfrage eine vom Benutzer ausgelöste Neuladeaktion ist.
Request.keepaliveSchreibgeschützt-
Enthält die
keepalive-Einstellung der Anfrage (trueoderfalse), die angibt, ob der Browser die zugehörige Anfrage am Leben hält, wenn die Seite, die sie ausgelöst hat, entladen wird, bevor die Anfrage abgeschlossen ist. Request.methodSchreibgeschützt-
Enthält die Methode der Anfrage (
GET,POST, etc.). Request.modeSchreibgeschützt-
Enthält den Modus der Anfrage (z.B.
cors,no-cors,same-origin,navigate). Request.redirectSchreibgeschützt-
Enthält den Modus, wie Weiterleitungen behandelt werden. Es kann
follow,errorodermanualsein. Request.referrerSchreibgeschützt-
Enthält den Referrer der Anfrage (z.B.
client). Request.referrerPolicySchreibgeschützt-
Enthält die Referrer-Policy der Anfrage (z.B.
no-referrer). Request.signalSchreibgeschützt-
Gibt das mit der Anfrage verbundene
AbortSignalzurück. Request.targetAddressSpaceSchreibgeschützt-
Gibt den Zieladressraum der Anfrage zurück, der angibt, ob es sich um eine Loopback-, lokale oder öffentliche Anfrage handelt.
Request.urlSchreibgeschützt-
Enthält die URL der Anfrage.
Instanz-Methoden
Request.arrayBuffer()-
Gibt ein Promise zurück, das mit einer
ArrayBuffer-Repräsentation des Anfragekörpers aufgelöst wird. Request.blob()-
Gibt ein Promise zurück, das mit einer
Blob-Repräsentation des Anfragekörpers aufgelöst wird. Request.bytes()-
Gibt ein Promise zurück, das mit einer
Uint8Array-Repräsentation des Anfragekörpers aufgelöst wird. Request.clone()-
Erstellt eine Kopie des aktuellen
Request-Objekts. Request.formData()-
Gibt ein Promise zurück, das mit einer
FormData-Repräsentation des Anfragekörpers aufgelöst wird. Request.json()-
Gibt ein Promise zurück, das mit dem Ergebnis des Parsens des Anfragekörpers als
JSONaufgelöst wird. Request.text()-
Gibt ein Promise zurück, das mit einer Text-Repräsentation des Anfragekörpers aufgelöst wird.
Hinweis: Die Funktionen für den Anfragekörper können nur einmal ausgeführt werden; nachfolgende Aufrufe werden mit einem TypeError abgelehnt, der anzeigt, dass der Body-Stream bereits verwendet wurde.
Beispiele
Im folgenden Beispiel erstellen wir eine neue Anfrage mit dem Request()-Konstruktor (für eine Bilddatei im selben Verzeichnis wie das Skript) und geben dann einige Eigenschaftswerte der Anfrage zurück:
const request = new Request("https://www.mozilla.org/favicon.ico");
const url = request.url;
const method = request.method;
const credentials = request.credentials;
Sie könnten dann diese Anfrage abrufen, indem Sie das Request-Objekt als Parameter an einen fetch()-Aufruf übergeben, zum Beispiel:
fetch(request)
.then((response) => response.blob())
.then((blob) => {
image.src = URL.createObjectURL(blob);
});
Im folgenden Beispiel erstellen wir eine neue Anfrage mit dem Request()-Konstruktor mit einigen Anfangsdaten und Body-Inhalt für eine API-Anfrage, die eine Body-Nutzlast benötigt:
const request = new Request("https://example.com", {
method: "POST",
body: '{"foo": "bar"}',
});
const url = request.url;
const method = request.method;
const credentials = request.credentials;
const bodyUsed = request.bodyUsed;
Hinweis:
Der Body kann nur ein Blob, ein ArrayBuffer, ein TypedArray, ein DataView, ein FormData, ein URLSearchParams, ein ReadableStream oder ein String-Objekt sowie ein String-Literal sein. Um ein JSON-Objekt zur Nutzlast hinzuzufügen, müssen Sie dieses Objekt stringifizieren.
Sie könnten dann diese API-Anfrage abrufen, indem Sie das Request-Objekt als Parameter an einen fetch()-Aufruf übergeben, zum Beispiel, und die Antwort erhalten:
fetch(request)
.then((response) => {
if (response.status !== 200) {
throw new Error("Something went wrong on API server!");
}
return response.json();
})
.then((response) => {
console.debug(response);
// …
})
.catch((error) => {
console.error(error);
});
Spezifikationen
| Spezifikation |
|---|
| Fetch # request-class |