55 lines
1.2 KiB
JavaScript
55 lines
1.2 KiB
JavaScript
|
/**
|
||
|
|
* @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 isInteger = require( './../../is-integer' ).isPrimitive;
|
||
|
|
var MAX_ARRAY_LENGTH = require( '@stdlib/constants/array/max-array-length' );
|
||
|
|
|
||
|
|
|
||
|
|
// MAIN //
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Tests if a value is a valid array length.
|
||
|
|
*
|
||
|
|
* @param {*} value - value to test
|
||
|
|
* @returns {boolean} boolean indicating if a value is a valid array length
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* var bool = isArrayLength( 3 );
|
||
|
|
* // returns true
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* var bool = isArrayLength( 3.14 );
|
||
|
|
* // returns false
|
||
|
|
*/
|
||
|
|
function isArrayLength( value ) {
|
||
|
|
return (
|
||
|
|
isInteger( value ) &&
|
||
|
|
value >= 0 &&
|
||
|
|
value <= MAX_ARRAY_LENGTH
|
||
|
|
);
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
// EXPORTS //
|
||
|
|
|
||
|
|
module.exports = isArrayLength;
|