【Node.js24.x】Object::URLSearchParams()メソッドの使い方

URLSearchParamsクラスは、ウェブアドレス（URL）のクエリ文字列、つまり?以降に続くkey=value形式の情報を簡単に操作するための機能を提供するクラスです。Node.jsに組み込まれており、システムエンジニアを目指す方々がURLを扱う際に非常に役立ちます。

このクラスを使用すると、与えられたクエリ文字列を解析し、個々のパラメータ（キーと値のペア）にアクセスしたり、新しいパラメータを追加したり、既存のパラメータの値を変更したり、削除したりすることが容易になります。例えば、ウェブサイトへのリクエストで送信されるフォームデータや、検索エンジンの検索条件などをプログラムで生成したり、逆に受け取ったURLから情報を抽出したりする際に活用されます。

URLSearchParamsのインスタンスは、new URLSearchParams()として作成します。生成されたインスタンスは、append()で新しいパラメータを追加したり、get()で特定のキーの値を取得したり、set()で値を更新したり、delete()でパラメータを削除したりする多彩なメソッドを提供します。これらの機能により、複雑なURLのクエリ部分を直感的かつ効率的に管理できるようになります。

Copy
1const mySearchParams = new URLSearchParams('name=John Doe&age=30');
2const name = mySearchParams.get('name'); // 'John Doe'

init

• init: URLSearchParamsオブジェクトの初期化に使用するデータ。以下のいずれかの形式で指定できます。
  • string: URLのクエリ文字列。例: "key1=value1&key2=value2"
  • iterable of key-value pairs: キーと値のペアの配列またはイテレータ。例: [['key1', 'value1'], ['key2', 'value2']]
  • object: キーと値のペアを持つオブジェクト。例: { key1: 'value1', key2: 'value2' }

URLSearchParams

URLSearchParamsメソッドは、URLのクエリ文字列を解析したり、操作したりするためのURLSearchParamsオブジェクトを返します。このオブジェクトは、キーと値のペアのセットとしてクエリパラメータを扱います。