2021年7月に行われた TC39 ミーティングで <a href="https://github.com/tc39/proposal-private-fields-in-in">Ergonomic brand checks for Private Fields</a> というプロポーザルが Stage 4 になりました。
このプロポーザルは、ES2022 に含まれる予定です。また、<a href="https://devblogs.microsoft.com/typescript/announcing-typescript-4-5-rc/#private-field-presence-checks">TypeScript 4.5 にも含まれる予定です</a>。
この記事では、Ergonomic brand checks for Private Fields について解説します。
<h2>概要</h2>
Ergonomic brand checks for Private Fields は、<code>in</code> 演算子を使ったプライベートフィールドの有無の判定を可能にするプロポーザルです。
<h3>現在の <code>in</code> 演算子</h3>
<code>in</code> 演算子は、オブジェクトが特定の名前のプロパティを持っているかどうかを判定するための二項演算子です。
左辺にプロパティの名前、右辺にオブジェクトを受け取ります。
<div class="remark-highlight"><pre class="language-js"><code class="language-js">const obj = { prop1: 1 };
console.log("prop1" in obj); // true
</code></pre></div>
<h3>新しい <code>in</code> 演算子</h3>
Ergonomic brand checks for Private Fields では、この <code>in</code> 演算子を拡張し、左辺に Private Identifier を取れるようになります。
Private Identifier は <code>#foo</code> のような形をした特別な識別子で、クラスのプライベートフィールドを表現するのに使われます。
たとえば、次のコードではクラス <code>Foo</code> は、<code>#prop1</code> というプライベートフィールドを持ちます。
このとき <code>#prop1</code> は Private Identifier です。
<div class="remark-highlight"><pre class="language-js"><code class="language-js">class Foo {
 #prop1;
}
</code></pre></div>
拡張された <code>in</code> 演算子では、次のようにしてオブジェクトにプライベートフィールドが含まれるかどうかをチェックできます。
<div class="remark-highlight"><pre class="language-js"><code class="language-js">#prop1 in obj
</code></pre></div>
しかし、プライベートフィールドはプライベートなので上記のコードはそのフィールドを持つクラスの中でのみ使うことができます。
つまり、次のようにクラスの外でプライベートフィールドに対して <code>in</code> を使うとエラーになります。
<div class="remark-highlight"><pre class="language-js"><code class="language-js">class Foo {
 #prop1;
}
console.log(#prop1 in new Foo());
// Uncaught SyntaxError: Private field '#prop1' must be declared in an enclosing class
</code></pre></div>
しかし、次のようなコードはエラーになりません。メソッド <code>foo</code> はクラス <code>Foo</code> の中にあるので、Private Identifier である <code>#foo</code> を <code>in</code> 演算子の左辺として使うことができます。
そして、この <code>foo</code> の中で <code>this</code> は <code>Foo</code> のインスタンスであり、それには当然 <code>#prop1</code> というプライベートプロパティが存在するので、<code>#prop1 in this</code> の結果は <code>true</code> になります。
<div class="remark-highlight"><pre class="language-js"><code class="language-js">class Foo {
 #prop1;
 foo() {
 return #prop1 in this;
 }
}
console.log(new Foo().foo()); // true
</code></pre></div>
<h2>モチベーション</h2>
存在しないプライベートフィールドにアクセスすると、実行時エラーが発生します。
その挙動と try / catch を組み合わせて、次のようにしてオブジェクトのクラスを判定できます。
<div class="remark-highlight"><pre class="language-js"><code class="language-js">class Foo {
 #brand;
 static isFoo(obj) {
 try {
 obj.#brand;
 return true;
 } catch {
 return false;
 }
 }
}
</code></pre></div>
<code>obj.#brand</code> にアクセスしたとき、<code>obj</code> が Foo のインスタンスでない場合、実行時エラーが発生し <code>catch</code> に入り <code>false</code> が返されます。
このようにして、あるオブジェクトが<code>Foo</code>のインスタンスであるかを検証するスタティックメソッドを作れます。
ですが、このパターンは冗長です。<code>in</code> 演算子を使えばもっと短く書けます。
<div class="remark-highlight"><pre class="language-js"><code class="language-js">class Foo {
 #brand;
 static isFoo(obj) {
 return #brand in obj;
 }
}
</code></pre></div>
これが、このプロポーザルの主なモチベーションです。
<a href="https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Operators/instanceof"><code>instanceof</code> 演算子</a>も基本的にはこの目的のために使えます。しかし <code>instanceof</code> 演算子はプロトタイプに依存するので、プロトタイプを書き換えることでその挙動を変更できます。
次の例では、 <code>obj</code> は <code>Foo</code> のインスタンスではありませんが、後からプロトタイプを書き換えているので <code>obj instanceof Foo</code> は <code>true</code> になっています。
<div class="remark-highlight"><pre class="language-js"><code class="language-js">class Foo {}
const foo = new Foo();
const obj = {};
Object.setPrototypeOf(obj, foo);
console.log(obj instanceof Foo); // true
</code></pre></div>
また、<a href="https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Global_Objects/Symbol/hasInstance">Symbol.hasInstance</a> を使って <code>instanceof</code> の挙動を変更することも可能です。
なので、より安全にオブジェクトのもとになったクラスを検証したい場合は <code>in</code> 演算子を使うと良いでしょう。
<h2>参考リンク</h2>
<ul>
<li><a href="https://tc39.es/ecma262/#prod-RelationalExpression">https://tc39.es/ecma262/#prod-RelationalExpression</a></li>
<li><a href="https://tc39.es/ecma262/#prod-PrivateIdentifier">https://tc39.es/ecma262/#prod-PrivateIdentifier</a></li>
<li><a href="https://github.com/tc39/proposal-private-fields-in-in">https://github.com/tc39/proposal-private-fields-in-in</a></li>
<li><a href="https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Operators/in">https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Operators/in</a></li>
</ul>