【Node.js24.x】URLSearchParams::URLSearchParams()関数の使い方

URLSearchParams関数は、Webアドレスの一部であるクエリパラメータをプログラム上で効率的に操作するためのURLSearchParamsオブジェクトを生成する関数です。このオブジェクトは、URLの末尾に「?key=value&foo=bar」のように続く部分を解析し、個々のパラメータをキーと値のペアとして扱います。

具体的には、クエリパラメータの追加、削除、取得、変更、存在確認、さらにはパラメータの並べ替えといった操作を、直感的かつ安全に行うための機能を提供します。同じキーを持つ複数のパラメータも適切に処理されるため、複雑なURL構造にも対応可能です。

URLSearchParams関数を用いて新しいオブジェクトを生成する際には、既存のクエリ文字列や、キーと値のペアの配列などを引数として渡すことで、初期値を設定できます。この機能はWeb標準のURLSearchParamsインターフェースに準拠しており、ウェブブラウザ環境での利用方法とほぼ同じ感覚でNode.js環境でも利用できます。

システム開発において、動的なURLを生成したり、受信したHTTPリクエストのURLから特定のパラメータの値を抽出・検証したりする場面は非常に多く、URLSearchParams関数はこれらのタスクを堅牢かつ簡潔に実現するための重要なツールとなります。これにより、URLの取り扱いに関する多くの手間を省き、エラーのリスクを低減することができます。

Copy
1const params = new URLSearchParams();
2params.append('name', 'Alice');
3params.append('age', '30');
4const queryString = params.toString();
5console.log(queryString);

init

• init: URLSearchParams オブジェクトの初期化に使用される値。文字列、キーと値のペアの配列、または URLSearchParams オブジェクトを指定できます。

URLSearchParams

URLSearchParamsコンストラクタは、URLのクエリ文字列を解析したり、操作したりするためのURLSearchParamsオブジェクトを生成します。