116 lines
2.1 KiB
Markdown
116 lines
2.1 KiB
Markdown
<!--
|
|
|
|
@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.
|
|
|
|
-->
|
|
|
|
# isArrayLength
|
|
|
|
> Test if a value is a valid array length.
|
|
|
|
<section class="usage">
|
|
|
|
## Usage
|
|
|
|
```javascript
|
|
var isArrayLength = require( '@stdlib/assert/is-array-length' );
|
|
```
|
|
|
|
#### isArrayLength( value )
|
|
|
|
Tests if a value is a valid `array` length.
|
|
|
|
```javascript
|
|
var bool = isArrayLength( 5 );
|
|
// returns true
|
|
|
|
bool = isArrayLength( -1 );
|
|
// returns false
|
|
|
|
bool = isArrayLength( 2.0e200 );
|
|
// returns false
|
|
|
|
bool = isArrayLength( 3.14 );
|
|
// returns false
|
|
|
|
bool = isArrayLength( null );
|
|
// returns false
|
|
```
|
|
|
|
</section>
|
|
|
|
<!-- /.usage -->
|
|
|
|
<section class="notes">
|
|
|
|
## Notes
|
|
|
|
- A valid `length` property for an [`Array`][mdn-array] is any integer value on the interval `[0, 2^32-1]`.
|
|
|
|
</section>
|
|
|
|
<!-- /.notes -->
|
|
|
|
<section class="examples">
|
|
|
|
## Examples
|
|
|
|
<!-- eslint no-undef: "error" -->
|
|
|
|
```javascript
|
|
var isArrayLength = require( '@stdlib/assert/is-array-length' );
|
|
|
|
var bool = isArrayLength( 5 );
|
|
// returns true
|
|
|
|
bool = isArrayLength( 0 );
|
|
// returns true
|
|
|
|
bool = isArrayLength( 2.0e200 );
|
|
// returns false
|
|
|
|
bool = isArrayLength( 5.256 );
|
|
// returns false
|
|
|
|
bool = isArrayLength( 1.0/0.0 );
|
|
// returns false
|
|
|
|
bool = isArrayLength( -1.0/0.0 );
|
|
// returns false
|
|
|
|
bool = isArrayLength( NaN );
|
|
// returns false
|
|
|
|
bool = isArrayLength( '5' );
|
|
// returns false
|
|
|
|
bool = isArrayLength( null );
|
|
// returns false
|
|
```
|
|
|
|
</section>
|
|
|
|
<!-- /.examples -->
|
|
|
|
<section class="links">
|
|
|
|
[mdn-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array
|
|
|
|
</section>
|
|
|
|
<!-- /.links -->
|