stdlib-js
<summary>
About stdlib...
</summary>
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
instanceOf
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
Test whether a value has in its prototype chain a specified constructor as a prototype property.
bash
npm install @stdlib/assert-instance-of
javascript
var instanceOf = require( '@stdlib/assert-instance-of' );
#### instanceOf( value, constructor )
Tests whether a value has in its prototype chain a specified constructor as a prototype property.
javascript
var inherit = require( '@stdlib/utils-inherit' );
function Foo() {
return this;
}
function Bar() {
return this;
}
inherit( Bar, Foo );
var bar = new Bar();
var bool = instanceOf( bar, Foo );
// returns true
TypeError if provided a constructor argument which is not callable.
javascript
var bool = instanceOf( {}, null );
// throws <TypeError>
- While the prototype of an object created using object literal notion is undefined, the function returns true when provided an object literal and the Object constructor. This maintains consistent behavior with the instanceof operator.
javascript
var Object = require( '@stdlib/object-ctor' );
var bool = ( {} instanceof Object );
// returns true
bool = instanceOf( {}, Object );
// returns true
javascript
var Number = require( '@stdlib/number-ctor' );
var Object = require( '@stdlib/object-ctor' );
var Function = require( '@stdlib/function-ctor' );
var instanceOf = require( '@stdlib/assert-instance-of' );
var bool = instanceOf( [], Array );
// returns true
bool = instanceOf( [], Object );
// returns true
bool = instanceOf( {}, Object );
// returns true
bool = instanceOf( new Date(), Date );
// returns true
bool = instanceOf( /.*/, RegExp );
// returns true
bool = instanceOf( instanceOf, Function );
// returns true
bool = instanceOf( null, Object );
// returns false
bool = instanceOf( 5, Number );
// returns false
bool = instanceOf( '5', String );
// returns false
bool = instanceOf( void 0, Object );
// returns false
bool = instanceOf( {}, Array );
// returns false
bool = instanceOf( {}, Function );
// returns false
@stdlib/assert-is-prototype-of][@stdlib/assert/is-prototype-of]: test if an object's prototype chain contains a provided prototype.
- [@stdlib/utils-constructor-name][@stdlib/utils/constructor-name]: determine the name of a value's constructor.
- [@stdlib/utils-inherit][@stdlib/utils/inherit]: implement prototypical inheritance by replacing the prototype of one constructor with the prototype of another constructor.
- [@stdlib/utils-type-of][@stdlib/utils/type-of]: determine a value's type.
