Headers.get()

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.

get()Headers インターフェイスのメソッドで、指定された名前の Headers オブジェクト内のヘッダーのすべての値のバイト文字列を返します。要求されたヘッダーが Headers オブジェクトに存在しない場合、null を返します。

セキュリティ上の理由から、いくつかのヘッダーはユーザーエージェントでしか制御できません。これには、禁止ヘッダー名禁止レスポンスヘッダー名があります。

構文

js
get(name)

引数

name

Headers オブジェクトから値を取得する HTTP ヘッダーの名前。指定された名前が HTTP ヘッダーの名前でない場合、このメソッドでは TypeError 例外が発生します。名前は大文字と小文字を区別しません。

返値

取得したヘッダーの値を表す文字列の配列です。このヘッダーが設定されていない場合は null を返します。

空の Headers オブジェクトの作成は簡単です。

js
const myHeaders = new Headers(); // 現在空です
myHeaders.get("Not-Set"); // null を返します

Headers.append を使用してヘッダーを追加し、get() を使用してヘッダーを取得できます。

js
myHeaders.append("Content-Type", "image/jpeg");
myHeaders.get("Content-Type"); // "image/jpeg" を返します

ヘッダーに複数の値が関連付けられている場合、ByteString には、Headers オブジェクトに追加された順序ですべての値が含まれます。

js
myHeaders.append("Accept-Encoding", "deflate");
myHeaders.append("Accept-Encoding", "gzip");
myHeaders.get("Accept-Encoding"); // "deflate,gzip" を返します
myHeaders
  .get("Accept-Encoding")
  .split(",")
  .map((v) => v.trimStart()); // [ "deflate", "gzip" ] を返します。

仕様書

Specification
Fetch Standard
# ref-for-dom-headers-get①

ブラウザーの互換性

BCD tables only load in the browser

関連情報