Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

【JavaScript ECMAScript】Proxy::handler.setインスタンスメソッドの使い方

handler.set()インスタンスメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

handler.set()メソッドは、Proxyオブジェクトに対してプロパティへの値の代入が行われる際に実行されるメソッドです。JavaScriptのProxyは、オブジェクトに対するさまざまな操作(プロパティへのアクセス、代入、関数呼び出しなど)をインターセプトし、その挙動をカスタマイズするための強力な機能を提供します。

handler.set()は、このProxy機能における「セッター」としての役割を担うトラップメソッドの一つです。具体的には、プロキシ化されたオブジェクトのプロパティに値を設定しようとしたときに、自動的にこのメソッドが呼び出されます。このメソッドは、ターゲットとなる元のオブジェクト、設定されるプロパティ名、新しい値、そしてProxyインスタンス自身(レシーバー)を引数として受け取ります。

開発者はhandler.set()を使って、プロパティの値を設定する前に特定の条件を検証するバリデーション処理を実装したり、不正な値の代入を拒否したり、代入時に他の関連データも更新するなどのカスタムロジックを定義できます。例えば、数値型のプロパティに文字列が代入されようとした場合にエラーを発生させるといった使い方が可能です。この仕組みにより、オブジェクトのデータの一貫性を保ち、外部からの不適切な操作を防ぎ、より堅牢で予測可能なアプリケーションの構築に貢献します。

公式リファレンス: handler.set()

構文(syntax)

1set(target, property, value, receiver) {
2  /* ここにプロパティ設定時のカスタムロジックを記述 */
3  target[property] = value; // 例: 元のオブジェクトに値を設定
4  return true; // プロパティ設定が成功したことを示す
5}

引数(parameters)

target, property, value, receiver

  • target: object: プロキシ対象のオブジェクト
  • property: string | symbol: 設定しようとしているプロパティの名前
  • value: any: プロパティに設定しようとしている値
  • receiver: object: 処理が適用されるオブジェクト(通常はプロキシ自身)

戻り値(return)

boolean

handler.set() メソッドは、プロキシオブジェクトへのプロパティ設定操作が成功したかどうかを示す真偽値(boolean)を返します。成功した場合は true を、失敗した場合は false を返します。

関連コンテンツ