Object.getOwnPropertySymbols()

概要

引数で与えられたオブジェクト上で直接見つかったすべてのsymbolプロパティの配列を返します。

構文

Object.getOwnPropertySymbols(obj)

引数

obj

symbolプロパティが返されるオブジェクト

説明

Object.getOwnPropertyNames()に似て、シンボルの配列として与えられたオブジェクトのすべてのシンボルプロパティを取得することができます。Object.getOwnPropertyNames()自体がオブジェクトのシンボルプロパティを含まず、文字列プロパティのみを含むことに注意して下さい。

すべてのオブジェクトが最初に自身のシンボルプロパティを持たないので、Object.getOwnPropertySymbols()は、オブジェクトにシンボルプロパティを設定しない限りは空の配列を返します。

例

var obj = {};
var a = Symbol('a');
var b = Symbol.for('b');

obj[a] = 'localSymbol';
obj[b] = 'globalSymbol';

var objectSymbols = Object.getOwnPropertySymbols(obj);

console.log(objectSymbols.length); // 2
console.log(objectSymbols);        // [Symbol(a), Symbol(b)]
console.log(objectSymbols[0]);     // Symbol(a)

仕様

ブラウザ実装状況

関連情報

• Object.getOwnPropertyNames()
• Symbol