DOM

インターフェイス

URLSearchParams インターフェイス

→● MS

このインターフェイスは URL のクエリー文字列の操作に役立つメソッドを定義します。

URLSearchParams を実装するオブジェクトは 直接 for...of で使うことができます。例えば次の 2行は等価です。

for (const [key, value] of mySearchParams) {}
for (const [key, value] of mySearchParams.entries()) {}

注： この機能は Web Worker 内で利用可能です

コンストラクター

new URLSearchParams() ●

URLSearchParams オブジェクトを返すコンストラクターです。

メソッド

URLSearchParams.append() ●

指定されたキーと値のペアを新しい検索パラメーターとして追加します。

URLSearchParams.delete() ●

指定された検索パラメーターとその値を、検索パラメーターのリストからすべて削除します。

URLSearchParams.entries()

このオブジェクトに含まれるすべてのキーと値のペアを列挙するためのイテレーターを返します。

URLSearchParams.forEach()

コールバック関数を介して、このオブジェクトに含まれるすべての値を列挙します。

URLSearchParams.get() ●

指定された検索パラメーターに対応する最初の値を返します。

URLSearchParams.getAll() ●

指定された検索パラメーターに対応するすべての値を返します。

URLSearchParams.has() ●

指定された検索パラメーターが存在するかを表す Boolean 値を返します。

URLSearchParams.keys()

このオブジェクトに含まれるすべてのキーと値のペアのキーを列挙するイテレーターを返します。

URLSearchParams.set() ●

指定された検索パラメーターに対応する値を設定します。複数の値が存在していた場合、それらは削除されます。

URLSearchParams.sort() ●

すべてのキーと値のペアを、キーを基準にソートします。

URLSearchParams.toString()

URL で使用するのに適したクエリー文字列を返します。

URLSearchParams.values()

このオブジェクトに含まれるすべてのキーと値のペアの値を列挙するイテレーターを返します。

例

var paramsString = "q=URLUtils.searchParams&topic=api";
var searchParams = new URLSearchParams(paramsString);

// 検索パラメーターを列挙する
for (let p of searchParams) {
  console.log(p);
}

searchParams.has("topic") === true; // true
searchParams.get("topic") === "api"; // true
searchParams.getAll("topic"); // ["api"]
searchParams.get("foo") === null; // true
searchParams.append("topic", "webdev");
searchParams.toString(); // "q=URLUtils.searchParams&topic=api&topic=webdev"
searchParams.set("topic", "More webdev");
searchParams.toString(); // "q=URLUtils.searchParams&topic=More+webdev"
searchParams.delete("topic");
searchParams.toString(); // "q=URLUtils.searchParams"

コラム

URLSearchParams コンストラクターは完全な URL をパースしません。ただし、先頭に ? が存在すれば、読み飛ばします。

var paramsString1 = "http://example.com/search?query=%40";
var searchParams1 = new URLSearchParams(paramsString1);

searchParams1.has("query"); // false
searchParams1.has("http://example.com/search?query"); // true

searchParams1.get("query"); // null
searchParams1.get("http://example.com/search?query"); // "@" (equivalent to decodeURIComponent('%40'))

var paramsString2 = "?query=value";
var searchParams2 = new URLSearchParams(paramsString2);
searchParams2.has("query"); // true

var url = new URL("http://example.com/search?query=%40");
var searchParams3 = new URLSearchParams(url.search);
searchParams3.has("query") // true

URL¶.searchParams→●

クエリ･オブジェクトを返す。

URLSearchParams¶.iterable→●

における反復される値ペアたちは、これ°の（名、値）ペアリストであり、前者の各ペアを成す［key／値］は、後者の各ペアを成す［名／値］が与えるとする。

URLSearchParams¶.stringifier→●

application/x-www-form-urlencoded 直列化器（これ°の（名、値）ペアリスト）を返す。

テスト