URLSearchParams: forEach() メソッド

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.

forEach() は URLSearchParams インターフェイスのメソッドを使用すると、コールバック関数を介してこのオブジェクトに含まれるすべての値を反復処理できます。

メモ: この機能はウェブワーカー内で利用可能です。

構文

js
forEach(callback)
forEach(callback, thisArg)

引数

callback

それぞれの要素に対して実行される関数で、以下の引数が渡されます。

value

URLSearchParams オブジェクトで現在処理中の項目の値です。

key

URLSearchParams オブジェクトで現在処理中の項目のキーです。

searchParams

forEach() が呼び出された URLSearchParams オブジェクトです。

thisArg 省略可

callback の実行中に this として使用される値です。

返値

なし (undefined)。

例

js
// テスト用の URLSearchParams オブジェクトの作成
const searchParams = new URLSearchParams("key1=value1&key2=value2");

// 値の記録
searchParams.forEach((value, key) => {
  console.log(value, key);
});

結果は次のとおりです。

value1 key1
value2 key2

仕様書

Specification
URL Standard
# dom-urlsearchparams-urlsearchparams

ブラウザーの互換性

BCD tables only load in the browser

関連項目

  • URL インターフェイス。