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

handler.ownKeys()メソッドは、JavaScriptのProxyオブジェクトにおいて、ターゲットオブジェクトのプロパティキーを列挙する操作をインターセプトし、その動作をカスタマイズするために実行されるメソッドです。Proxyは、オブジェクトの基本的な操作をカスタムの振る舞いに変更する仕組みですが、このownKeysメソッドは、オブジェクトが自身のプロパティ名をどのように外部に公開するかを制御する役割を担います。

具体的には、Object.keys()、Object.getOwnPropertyNames()、Object.getOwnPropertySymbols()、そしてReflect.ownKeys()といったメソッドがターゲットオブジェクトに対して呼び出された際に、このhandler.ownKeys()メソッドが実行されます。開発者はこのメソッドを実装することで、本来ターゲットが返すプロパティキーのリストとは異なる、独自の文字列やシンボルを含む配列を返すことができます。これにより、特定のプロパティを列挙結果から隠蔽したり、表示順序を変更したりするなど、プロパティの可視性や列挙の挙動を柔軟に調整することが可能になります。

ただし、ownKeysメソッドには厳格な「不変条件（invariant）」と呼ばれるルールが存在します。例えば、ターゲットオブジェクトが「設定不可（non-configurable）」なプロパティを持っている場合、そのプロパティのキーはownKeysが返す配列に必ず含まれていなければなりません。また、ターゲットオブジェクトが「拡張不可（non-extensible）」である場合、ターゲットが持つ全ての自身のプロパティのキーが、返される配列に含まれている必要があります。これらのルールに違反する配列を返すと、実行時にTypeErrorが発生し、プログラムの安定性に影響を与えます。この制約は、オブジェクトの整合性を保つ上で非常に重要ですので、Proxyを安全に利用するためにはこれらのルールを正確に理解し遵守することが求められます。

Copy
1const handler = {
2  ownKeys(target) {
3    return Reflect.ownKeys(target);
4  }
5};

target

• target: object: Proxyオブジェクトがラップする元のオブジェクト

Array<string | symbol>

このメソッドは、プロキシオブジェクトの自身のプロパティのキー（文字列またはシンボル）の配列を返します。