All files / assert/is-iterable-like/lib main.js

100% Statements 65/65
100% Branches 6/6
100% Functions 1/1
100% Lines 65/65

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 661x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 10x 10x 10x 7x 7x 3x 3x 10x 10x 10x 10x 10x 1x 1x 1x 1x 1x  
/**
* @license Apache-2.0
*
* Copyright (c) 2018 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*    http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
 
'use strict';
 
// MODULES //
 
var isPrimitive = require( '@stdlib/assert/is-primitive' );
var isFunction = require( '@stdlib/assert/is-function' );
var ITERATOR = require( '@stdlib/symbol/iterator' );
var isIteratorLike = require( '@stdlib/assert/is-iterator-like' );
 
 
// MAIN //
 
/**
* Tests if a value is iterable-like.
*
* @param {*} value - value to test
* @returns {boolean} boolean indicating whether a value is iterable-like
*
* @example
* var bool = isIterableLike( [] );
* // returns <boolean>
*
* @example
* var bool = isIterableLike( {} );
* // returns false
*
* @example
* var bool = isIterableLike( null );
* // returns false
*/
function isIterableLike( value ) {
	var f;
	if ( isPrimitive( value ) ) {
		return false;
	}
	f = value[ ITERATOR ];
	return (
		isFunction( f ) &&
		f.length === 0 &&
		isIteratorLike( value[ ITERATOR ]() ) // Why this form? In order to preserve `this`.
	);
}
 
 
// EXPORTS //
 
module.exports = isIterableLike;