Object.prototype.__lookupSetter__()

構文

__lookupSetter__(prop)

引数

prop

セッター関数を返すプロパティの名前を表す文字列です。

返値

指定したプロパティのセッターとしてバインドされた関数です。そのようなプロパティが得られない場合、またはプロパティがデータプロパティである場合は undefined を返します。

解説

Object.prototype 継承するすべてのオブジェクト（つまり、 null プロトタイプオブジェクトを除くすべてのオブジェクト）は __lookupSetter__() メソッドを継承しています。オブジェクトのプロパティにセッターが定義されている場合、そのプロパティは設定時に関数を呼び出すだけなので、そのプロパティを通してセッター関数を参照することはできません。 __lookupSetter__() を使用することで、そのセッター関数を参照することができます。

__lookupSetter__() は、指定したプロパティを探すためにプロトタイプチェーンを走査します。プロトタイプチェーンの中にあるオブジェクトが指定した自分自身のプロパティを持っている場合、そのプロパティのプロパティ記述子の set 属性を返します。そのプロパティがデータプロパティの場合は、undefined を返します。プロパティがプロトタイプチェーン全体で得られない場合、 undefined を返します。

__lookupSetter__() は仕様書で "normative optional" と定義されており、これは実装することを要求されていないということです。しかし、主要なブラウザーはすべて実装していますし、使い続けられているため、除去される可能性は低いでしょう。ブラウザーが __lookupSetter__() を実装する場合、__lookupGetter__()、__defineGetter__()、__defineSetter__() の各メソッドも実装する必要があります。

例

__lookupSetter__() の使用

const obj = {
  set foo(value) {
    this.bar = value;
  },
};

obj.__lookupSetter__("foo");
// [Function: set foo]

標準の方法でセッタープロパティを参照

プロパティのセッターを参照するには、 Object.getOwnPropertyDescriptor() API を使用しましょう。 __lookupSetter__() と比較して、このメソッドではシンボルプロパティを参照することができます。 Object.getOwnPropertyDescriptor() メソッドは、 Object.prototype を継承しないため __lookupSetter__() メソッドを持たない null プロトタイプオブジェクトでも動作します。もし __lookupSetter__() のプロトタイプチェーンを走査する動作が重要であれば、 Object.getPrototypeOf() を使って自分で実装することができます。

const obj = {
  set foo(value) {
    this.bar = value;
  },
};

Object.getOwnPropertyDescriptor(obj, "foo").set;
// [Function: set foo]

const obj2 = {
  __proto__: {
    set foo(value) {
      this.bar = value;
    },
  },
};

function findSetter(obj, prop) {
  while (obj) {
    const desc = Object.getOwnPropertyDescriptor(obj, prop);
    if (desc) {
      return desc.set;
    }
    obj = Object.getPrototypeOf(obj);
  }
}

console.log(findSetter(obj2, "foo")); // [Function: set foo]

仕様書

ブラウザーの互換性

関連情報

• Object.prototype.__lookupSetter__ のポリフィル (core-js)
• Object.prototype.__lookupGetter__()
• set
• Object.getOwnPropertyDescriptor()
• Object.prototype.__defineGetter__()
• Object.prototype.__defineSetter__()
• JavaScript ガイド: ゲッターとセッターの定義