main.js (1467B)
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 isInteger = require( '@stdlib/math/base/assert/is-integer' ); 24 var MAX_LENGTH = require( '@stdlib/constants/array/max-array-length' ); 25 26 27 // MAIN // 28 29 /** 30 * Tests if a value is an array-like object. 31 * 32 * @param {*} value - value to test 33 * @returns {boolean} boolean indicating if a value is an array-like object 34 * 35 * @example 36 * var bool = isArrayLikeObject( [] ); 37 * // returns true 38 * 39 * @example 40 * var bool = isArrayLikeObject( { 'length':10 } ); 41 * // returns true 42 * 43 * @example 44 * var bool = isArrayLikeObject( 'beep' ); 45 * // returns false 46 */ 47 function isArrayLikeObject( value ) { 48 return ( 49 typeof value === 'object' && 50 value !== null && 51 typeof value.length === 'number' && 52 isInteger( value.length ) && 53 value.length >= 0 && 54 value.length <= MAX_LENGTH 55 ); 56 } 57 58 59 // EXPORTS // 60 61 module.exports = isArrayLikeObject;