main.js (1326B)
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 isFunction = require( './../../is-function' ); 24 25 26 // MAIN // 27 28 /** 29 * Tests if a value is iterator-like. 30 * 31 * @param {*} value - value to test 32 * @returns {boolean} boolean indicating whether value is iterator-like 33 * 34 * @example 35 * var it = { 36 * 'next': function noop() {} 37 * }; 38 * var bool = isIteratorLike( it ); 39 * // returns true 40 * 41 * @example 42 * var bool = isIteratorLike( {} ); 43 * // returns false 44 * 45 * @example 46 * var bool = isIteratorLike( null ); 47 * // returns false 48 */ 49 function isIteratorLike( value ) { 50 return ( 51 value !== null && 52 typeof value === 'object' && 53 isFunction( value.next ) && 54 value.next.length === 0 55 ); 56 } 57 58 59 // EXPORTS // 60 61 module.exports = isIteratorLike;