Headers.delete()

delete() は Headers インターフェイスのメソッドで、現在の Headers オブジェクトからヘッダーを削除します。

このメソッドでは、次の場合に TypeError が発生します。

  • name 引数の値が HTTP ヘッダーの名前ではない場合。
  • ガードの値が immutable である場合。

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

構文

js
delete(name)

引数

name

Headers オブジェクトから削除する HTTP ヘッダーの名前。

返値

なし (undefined)。

例

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

js
const myHeaders = new Headers(); // Currently empty

Headers.append を使用して、これにヘッダーを追加できます。

js
myHeaders.append("Content-Type", "image/jpeg");
myHeaders.get("Content-Type"); // Returns 'image/jpeg'

その後、再度削除することができます。

js
myHeaders.delete("Content-Type");
myHeaders.get("Content-Type"); // Returns null, as it has been deleted

仕様書

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

ブラウザーの互換性

BCD tables only load in the browser

関連情報