-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmain.js
54 lines (45 loc) · 1.23 KB
/
main.js
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
/**
* @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;