time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

main.js (1551B)

      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 isPrimitive = require( './../../is-primitive' );
     24 var isFunction = require( './../../is-function' );
     25 var ITERATOR = require( '@stdlib/symbol/iterator' );
     26 var isIteratorLike = require( './../../is-iterator-like' );
     27 
     28 
     29 // MAIN //
     30 
     31 /**
     32 * Tests if a value is iterable-like.
     33 *
     34 * @param {*} value - value to test
     35 * @returns {boolean} boolean indicating whether a value is iterable-like
     36 *
     37 * @example
     38 * var bool = isIterableLike( [] );
     39 * // returns <boolean>
     40 *
     41 * @example
     42 * var bool = isIterableLike( {} );
     43 * // returns false
     44 *
     45 * @example
     46 * var bool = isIterableLike( null );
     47 * // returns false
     48 */
     49 function isIterableLike( value ) {
     50 	var f;
     51 	if ( isPrimitive( value ) ) {
     52 		return false;
     53 	}
     54 	f = value[ ITERATOR ];
     55 	return (
     56 		isFunction( f ) &&
     57 		f.length === 0 &&
     58 		isIteratorLike( value[ ITERATOR ]() ) // Why this form? In order to preserve `this`.
     59 	);
     60 }
     61 
     62 
     63 // EXPORTS //
     64 
     65 module.exports = isIterableLike;