main.js (1652B)
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 if a value is generator object-like. 25 * 26 * @param {*} value - value to test 27 * @returns {boolean} boolean indicating whether value is generator object-like 28 * 29 * @example 30 * var gen = { 31 * 'next': function noop() {}, 32 * 'return': function noop() {}, 33 * 'throw': function noop() {} 34 * }; 35 * var bool = isGeneratorObjectLike( gen ); 36 * // returns true 37 * 38 * @example 39 * function* generateID() { 40 * var idx = 0; 41 * while ( idx < idx+1 ) { 42 * yield idx; 43 * idx += 1; 44 * } 45 * } 46 * var bool = isGeneratorObjectLike( generateID() ); 47 * // returns true 48 * 49 * @example 50 * var bool = isGeneratorObjectLike( {} ); 51 * // returns false 52 * 53 * @example 54 * var bool = isGeneratorObjectLike( null ); 55 * // returns false 56 */ 57 function isGeneratorObjectLike( value ) { 58 return ( 59 value !== null && 60 typeof value === 'object' && 61 typeof value.next === 'function' && 62 typeof value.return === 'function' && 63 typeof value.throw === 'function' 64 ); 65 } 66 67 68 // EXPORTS // 69 70 module.exports = isGeneratorObjectLike;