Symbol.hasInstance
MDN Web Docs · نسخهٔ df622a2a1c1e · CC BY-SA 2.5 و مجوز جداگانهٔ ناشر برای نمونهکد
The **Symbol.hasInstance** static data property represents the well-known symbol Symbol.hasInstance. The {{jsxref("instanceof")}} operator looks up this symbol on its right-hand operand for the method used to determine if the constructor object recognizes an object as its instance.
{{InteractiveExample("JavaScript Demo: Symbol.hasInstance")}}
class Array1 {
static [Symbol.hasInstance](instance) {
return Array.isArray(instance);
}
}
console.log([] instanceof Array1);
// Expected output: trueValue
The well-known symbol Symbol.hasInstance.
{{js_property_attributes(0, 0, 0)}}
Description
The instanceof operator uses the following algorithm to calculate the return value of object instanceof constructor:
- If
constructorhas a[Symbol.hasInstance]()method, then call it withobjectas the first argument and return the result, coerced to a boolean. Throw a {{jsxref("TypeError")}} ifconstructoris not an object, or ifconstructor[Symbol.hasInstance]is not one ofnull,undefined, or a function. - Otherwise, if
constructordoesn't have a[Symbol.hasInstance]()method (constructor[Symbol.hasInstance]isnullorundefined), then determine the result using the same algorithm as [Function.prototype[Symbol.hasInstance]()](/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function/Symbol.hasInstance). Throw a {{jsxref("TypeError")}} ifconstructoris not a function.
Because all functions inherit from Function.prototype by default, most of the time, the [Function.prototype[Symbol.hasInstance]()](/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function/Symbol.hasInstance) method specifies the behavior of instanceof when the right-hand side is a function.
Examples
Custom instanceof behavior
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); // truefunction MyArray() {}
Object.defineProperty(MyArray, Symbol.hasInstance, {
value(instance) {
return Array.isArray(instance);
},
});
console.log([] instanceof MyArray); // trueChecking the instance of an object
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)); // trueSpecifications
{{Specifications}}
Browser compatibility
{{Compat}}
See also
- {{jsxref("instanceof")}}
- [
Function.prototype[Symbol.hasInstance]()](/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function/Symbol.hasInstance)