Private Field Presence Checks

TL;DR

ES2022で策定された「Ergonomic brand checks for Private Fields」をTypeScriptでサポート。

Ergonomic brand checks for Private Fields

https://github.com/tc39/proposal-private-fields-in-in

メソッドに渡された引数が特定のプライベートフィールドを持つかどうかを in 演算子で判定できる機能。

Dog

class Dog {
  #name!: string;

  constructor(name: string) {
    this.#name = name;
  }

  static isDog(arg: any) {
    return #name in arg; // <=== これ！
  }
}

const shiba = new Dog("しげる");

// true
Dog.isDog(shiba);

「ブランドチェック」と名付けられたのは、クラス外部からアクセスできないプライベートフィールドを使った優位性にある。

brand checks

検証してみよう。Dogと全く同じフィールドを持つCatクラスを宣言する。

Cat

class Cat {
  #name!: string;

  constructor(name: string) {
    this.#name = name;
  }

  static isCat(arg: any) {
    return #name in arg;
  }
}

Dog

class Dog {
  #name!: string;

  constructor(name: string) {
    this.#name = name;
  }

  static isDog(arg: any) {
    return #name in arg;
  }
}

const strayCat = new Cat("しげる");

// true
Cat.isCat(strayCat);

DogのしげるとCatのしげるは名前が同じでも、それぞれ別のクラスのインスタンスである。

Dog.isDog(shiba); // true
Dog.isDog(strayCat); // false

Cat.isCat(shiba); // false
Cat.isCat(strayCat); // true

もう1回クラスのソースを見てみよう。

class Dog {
  #name!: string;bs
  ...
  static isDog(arg: any) {
    return #name in arg;
  }

Dog#nameにアクセスできるのはDog（とそのインスタンス）だけ。

CatインスタンスはDog#nameにアクセスできないのでfalseになる。 DogインスタンスであればDog#nameにアクセスできるのでtrueになる。

クラスのブランドが担保できることから「ブランドチェック」と名付けられた。

type predicates

TypeScriptには「type predicates」という型の同一性を検査する手法がある。

https://www.typescriptlang.org/docs/handbook/2/narrowing.html#using-type-predicates

この手法は「特定のプロパティを持つかどうか」を検査するもの。

function isDogPredicate(arg: any): arg is Dog {
  return (arg as Dog).name !== undefined;
}

Dog

class Dog {
  #name: string;
  
  constructor(name: string) {
    this.#name = name;
  }

  static isDog(arg: any) {
    return #name in arg;
  }
  
  get name() {
    return this.#name;
  }
}

Cat

class Cat {
  #name: string;

  constructor(name: string) {
    this.#name = name;
  }

  static isDog(arg: any) {
    return #name in arg;
  }
  
  get name() {
    return this.#name;
  }
}

別のインスタンスであってもプロパティを持っていれば同一とみなされる。

const strayCat = new Cat("しげる");

// true
isDogPredicate(strayCat);

ブランドチェックはクラスが同じかどうか検査されるため、type predicatesと比較して優位性がある。

const strayCat = new Cat("しげる");

// false
Dog.isDog(strayCat);