Cette page a été traduite à partir de l'anglais par la communauté. Vous pouvez contribuer en rejoignant la communauté francophone sur MDN Web Docs.

View in English Always switch to English

Headers : méthode get()

Baseline Large disponibilité

Cette fonctionnalité est bien établie et fonctionne sur de nombreux appareils et versions de navigateurs. Elle est disponible sur tous les navigateurs depuis mars 2017.

Note : Cette fonctionnalité est disponible via les Web Workers.

La méthode get() de l'interface Headers retourne une chaîne de caractères d'octets contenant toutes les valeurs d'un en-tête dans un objet Headers avec un nom donné. Si l'en-tête demandé n'existe pas dans l'objet Headers, elle retourne null.

Pour des raisons de sécurité, certains en-têtes ne peuvent être contrôlés que par l'agent utilisateur. Ces en-têtes incluent les en-têtes de requête interdits et les noms d'en-têtes de réponse interdits.

Syntaxe

js
get(name)

Paramètres

name

Nom de l'en-tête HTTP dont vous souhaitez récupérer les valeurs à partir de l'objet Headers. Si le nom donné ne correspond pas à la production field-name (angl.) dans la spécification HTTP, cette méthode lance une TypeError. Le nom n'est pas sensible à la casse.

Valeur de retour

Une séquence de String représentant les valeurs de l'en-tête récupéré ou null si cet en-tête n'est pas défini.

Exemples

Créer un objet Headers vide est simple :

js
const mesEnTetes = new Headers(); // Actuellement vide
mesEnTetes.get("Not-Set"); // Retourne null

Vous pouvez ajouter un en-tête à cet objet en utilisant Headers.append, puis le récupérer en utilisant get() :

js
mesEnTetes.append("Content-Type", "image/jpeg");
mesEnTetes.get("Content-Type"); // Retourne "image/jpeg"

Si l'en-tête a plusieurs valeurs associées, la chaîne de caractères d'octets contiendra toutes les valeurs, dans l'ordre dans lequel elles ont été ajoutées à l'objet Headers :

js
mesEnTetes.append("Accept-Encoding", "deflate");
mesEnTetes.append("Accept-Encoding", "gzip");
mesEnTetes.get("Accept-Encoding"); // Retourne "deflate, gzip"
mesEnTetes
  .get("Accept-Encoding")
  .split(",")
  .map((v) => v.trimStart()); // Retourne [ "deflate", "gzip" ]

Spécifications

Spécification
Fetch
# ref-for-dom-headers-get①

Compatibilité des navigateurs

Voir aussi