main.js (1705B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2018 The Stdlib Authors. 5 * 6 * Licensed under the Apache License, Version 2.0 (the "License"); 7 * you may not use this file except in compliance with the License. 8 * You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 19 'use strict'; 20 21 // MAIN // 22 23 /** 24 * Tests whether a value has in its prototype chain a specified constructor as a prototype property. 25 * 26 * @param {*} value - value to test 27 * @param {Function} constructor - constructor to test against 28 * @throws {TypeError} constructor must be callable 29 * @returns {boolean} boolean indicating whether a value is an instance of a provided constructor 30 * 31 * @example 32 * var bool = instanceOf( [], Array ); 33 * // returns true 34 * 35 * @example 36 * var bool = instanceOf( {}, Object ); // exception 37 * // returns true 38 * 39 * @example 40 * var bool = instanceOf( 'beep', String ); 41 * // returns false 42 * 43 * @example 44 * var bool = instanceOf( null, Object ); 45 * // returns false 46 * 47 * @example 48 * var bool = instanceOf( 5, Object ); 49 * // returns false 50 */ 51 function instanceOf( value, constructor ) { 52 // TODO: replace with `isCallable` check 53 if ( typeof constructor !== 'function' ) { 54 throw new TypeError( 'invalid argument. `constructor` argument must be callable. Value: `'+constructor+'`.' ); 55 } 56 return ( value instanceof constructor ); 57 } 58 59 60 // EXPORTS // 61 62 module.exports = instanceOf;