Response : méthode statique json()

Syntaxe

Response.json(data)
Response.json(data, options)

Paramètres

data

Les données JSON à utiliser comme corps de la réponse.

options Facultatif

Un objet d'options contenant les paramètres de la réponse, incluant le code de statut, le texte de statut et les en-têtes. Ceci est identique au paramètre options du constructeur Response().

status

Le code de statut de la réponse, par exemple 200.

statusText

Le message de statut associé au code de statut. Pour un statut de 200 cela pourrait être OK.

headers

Tous les en-têtes que vous souhaitez ajouter à votre réponse, contenus dans un objet Headers ou un objet littéral de paires clé/valeur de type String (voir la référence des en-têtes HTTP).

Valeur de retour

Un objet Response.

Exceptions

TypeError

Levée si data ne peut pas être converti en chaîne JSON. Cela peut arriver si les données sont un objet JavaScript qui possède une méthode, ou qui a une référence circulaire, ou si l'objet passé est undefined.

Exemples

Réponse avec des données JSON

Cet exemple interactif montre comment créer un objet réponse JSON, et journalise l'objet nouvellement créé pour inspection (le code de journalisation est masqué car il n'est pas pertinent).

<pre id="journal"></pre>

const elementJournal = document.getElementById("journal");
function log(text) {
  elementJournal.innerText += `${text}\n`;
}

async function journaliserLaReponse(reponse) {
  const texteReponse = await reponse.text();
  log(`body: ${texteReponse}`);
  reponse.headers.forEach((enTete) => log(`header: ${enTete}`));
  log(`status: ${reponse.status}`);
  log(`statusText: ${reponse.statusText}`);
  log(`type: ${reponse.type}`);
  log(`url: ${reponse.url}`);
  log(`ok: ${reponse.ok}`);
  log(`redirected: ${reponse.redirected}`);
  log(`bodyUsed: ${reponse.bodyUsed}`);
}

Le code ci-dessous crée un objet Response avec le corps JSON { ma: "donnée" } et l'en-tête défini à application/json.

const reponseJson = Response.json({ ma: "donnée" });
journaliserLaReponse(reponseJson);

L'objet possède les propriétés suivantes. Notez que le corps et l'en-tête sont définis comme attendu, et que le statut par défaut est 200.

Réponse avec des données JSON et options

Cet exemple montre comment créer un objet réponse JSON avec les options status et statusText.

<pre id="journal"></pre>

const elementJournal = document.getElementById("journal");
function log(text) {
  elementJournal.innerText += `${text}\n`;
}

async function journaliserLaReponse(reponse) {
  const texteReponse = await reponse.text();
  log(`body: ${texteReponse}`);
  reponse.headers.forEach((enTete) => log(`header: ${enTete}`));
  log(`status: ${reponse.status}`);
  log(`statusText: ${reponse.statusText}`);
  log(`type: ${reponse.type}`);
  log(`url: ${reponse.url}`);
  log(`ok: ${reponse.ok}`);
  log(`redirected: ${reponse.redirected}`);
  log(`bodyUsed: ${reponse.bodyUsed}`);
}

Le code ci-dessous crée un objet Response avec le corps JSON { une: "donnée", plus: "de l'information" } et l'en-tête défini à application/json. Il définit aussi le statut à 307 et le texte de statut approprié ("Temporary Redirect").

const reponseJson = Response.json(
  { une: "donnée", plus: "de l'information" },
  { status: 307, statusText: "Temporary Redirect" },
);
journaliserLaReponse(reponseJson);

L'objet possède les propriétés suivantes, qui sont définies comme attendu. Notez que la propriété ok de la réponse est passée à false car la valeur du statut n'est pas comprise entre 200 et 299.

Spécifications

Compatibilité des navigateurs

Voir aussi

• L'API ServiceWorker