Symbol.hasInstance

¥Value

众所周知的符号 @@hasInstance。

¥The well-known symbol @@hasInstance.

¥Description

instanceof 运算符使用以下算法来计算 object instanceof constructor 的返回值：

¥The instanceof operator uses the following algorithm to calculate the return value of object instanceof constructor:

1. 如果 constructor 有 @@hasInstance 方法，则以 object 作为第一个参数调用它并返回结果 强制为布尔值。如果 constructor 不是对象，或者 constructor[@@hasInstance] 不是 null、undefined 或函数之一，则抛出 TypeError。
2. 否则，如果 constructor 没有 @@hasInstance 方法（constructor[@@hasInstance] 是 null 或 undefined），则使用与 Function.prototype[@@hasInstance] 相同的算法确定结果。如果 constructor 不是函数，则抛出 TypeError。

因为默认情况下所有函数都继承自 Function.prototype，所以大多数时候，Function.prototype[@@hasInstance] 方法指定了当右侧是函数时 instanceof 的行为。

¥Because all functions inherit from Function.prototype by default, most of the time, the Function.prototype[@@hasInstance] method specifies the behavior of instanceof when the right-hand side is a function.

¥Examples

¥Custom instanceof behavior

你可以像这样实现自定义 instanceof 行为，例如：

¥You could implement your custom instanceof behavior like this, for example:

class MyArray {
  static [Symbol.hasInstance](instance) {
    return Array.isArray(instance);
  }
}
console.log([] instanceof MyArray); // true

function MyArray() {}
Object.defineProperty(MyArray, Symbol.hasInstance, {
  value(instance) {
    return Array.isArray(instance);
  },
});
console.log([] instanceof MyArray); // true

¥Checking the instance of an object

就像使用 instanceof 关键字检查对象是否是类的实例一样，我们也可以使用 Symbol.hasInstance 进行此类检查。

¥Just in the same manner at which you can check if an object is an instance of a class using the instanceof keyword, we can also use Symbol.hasInstance for such checks.

class Animal {
  constructor() {}
}

const cat = new Animal();

console.log(Animal[Symbol.hasInstance](cat)); // true

¥See also

• instanceof
• Function.prototype[@@hasInstance]()