【JSリファレンス】ownKeysハンドラー(Proxy)

更新日：2024/06/14

ownKeysハンドラーは、Proxyコンストラクターに渡すハンドラーオブジェクトで使用可能なメソッドです。

Proxyオブジェクトの[[OwnPropertyKeys]]スロットが呼び出された時、ハンドラーで定義した関数が呼び出されます。

※[[OwnPropertyKeys]]スロットは、Object.keys()などで呼び出され、オブジェクトが所有するシンボルも含めた全てのプロパティの名前取得を行います。
（プロトタイプチェーンは含めません。）

 

■構文


ownKeys: function( target ){ }
  1. target: 対象となるオブジェクト
アレイライクオブジェクト

異なる場合TypeError

 

■戻り値の検証

戻り値オブジェクトの数値プロパティの値をリストにしたものを、戻り値リストとします。

targetが所有するプロパティ名のリストをtargetリストとします。
targetが所有するプロパティで、configurable属性が false の名前リストを 構成不可リストとします。

以上の条件で、次の検証を行います。

▶1: 戻り値リストに重複がある場合、TypeErrorが発生します。

▶2: targetが拡張可能(Object.isExtensible()の結果がtrue)で、構成不可リストが空の場合、戻り値オブジェクトを返します。

▶3: 構成不可リストの各値が、戻り値リストに存在しない場合、TypeErrorが発生します。

▶4: targetが拡張不可、かつ、戻り値リストとtargetリストの内容が一致しない（順不同）場合、TypeErrorが発生します。

▶5: ここまででTypeErrorが発生しない場合、戻り値オブジェクトを返します。

 

■使用例

const obj = {value:100}

const handlerObj = {
    ownKeys: function( target ){
        const result = Reflect.ownKeys( target );
        result.push( "prop" );
        result.push( Symbol() );
        return result;
    }
};
const proxyObj = new Proxy( obj ,handlerObj );

console.log( Reflect.ownKeys( proxyObj ) );
 // 結果: [ "value", "prop", Symbol() ]
console.log( Object.getOwnPropertyNames( proxyObj ) );
 // 結果: [ "value", "prop" ]
console.log( Object.getOwnPropertySymbols( proxyObj ) );
 // 結果: [  Symbol() ]
console.log( Object.keys( proxyObj ) );
 // 結果: [ "value" ]

※Object.keys()は、検証した結果を受け取り、結果に含まれるシンボルを除外します。
さらに、残ったプロパティ名がtargetに存在しない、またはenumerable属性が false なら除外します。

 

関連ページ

●Reflect.ownKeys()
●Object.getOwnPropertyNames()
●Object.getOwnPropertySymbols()
●Object.keys()

更新日：2024/06/14

書いた人（管理人）：けーちゃん

スポンサーリンク

記事の内容について

null

こんにちはけーちゃんです。
説明するのって難しいですね。

「なんか言ってることおかしくない？」
たぶん、こんなご意見あると思います。

裏付けを取りながら記事を作成していますが、僕の勘違いだったり、そもそも情報源の内容が間違えていたりで、正確でないことが多いと思います。
そんなときは、ご意見もらえたら嬉しいです。

掲載コードについては事前に動作確認をしていますが、貼り付け後に体裁を整えるなどをした結果動作しないものになっていることがあります。
生暖かい視線でスルーするか、ご指摘ください。

ご意見、ご指摘はこちら。
https://jsref.affi-sapo-sv.com/info.php

 

このサイトは、リンクフリーです。大歓迎です。