main.js (1534B)
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 // MODULES // 22 23 var hasGeneratorSupport = require( './../../has-generator-support' ); 24 var nativeClass = require( '@stdlib/utils/native-class' ); 25 26 27 // VARIABLES // 28 29 var hasGenerators = hasGeneratorSupport(); 30 31 32 // MAIN // 33 34 /** 35 * Tests if a value is a generator object. 36 * 37 * @param {*} value - value to test 38 * @returns {boolean} boolean indicating whether value is a generator object 39 * 40 * @example 41 * function* generateID() { 42 * var idx = 0; 43 * while ( idx < idx+1 ) { 44 * yield idx; 45 * idx += 1; 46 * } 47 * } 48 * var bool = isGeneratorObject( generateID() ); 49 * // returns true 50 * 51 * @example 52 * var bool = isGeneratorObject( {} ); 53 * // returns false 54 * 55 * @example 56 * var bool = isGeneratorObject( null ); 57 * // returns false 58 */ 59 function isGeneratorObject( value ) { 60 return ( hasGenerators && nativeClass( value ) === '[object Generator]' ); 61 } 62 63 64 // EXPORTS // 65 66 module.exports = isGeneratorObject;