113 lines
2.0 KiB
Markdown
113 lines
2.0 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.
|
||
|
|
|
||
|
|
-->
|
||
|
|
|
||
|
|
# isArrayLike
|
||
|
|
|
||
|
|
> Test if a value is array-like.
|
||
|
|
|
||
|
|
<section class="usage">
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var isArrayLike = require( '@stdlib/assert/is-array-like' );
|
||
|
|
```
|
||
|
|
|
||
|
|
#### isArrayLike( value )
|
||
|
|
|
||
|
|
Tests if a value is [array-like][array-like].
|
||
|
|
|
||
|
|
<!-- eslint-disable object-curly-newline -->
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var bool = isArrayLike( [] );
|
||
|
|
// returns true
|
||
|
|
|
||
|
|
bool = isArrayLike( { 'length': 10 } );
|
||
|
|
// returns true
|
||
|
|
```
|
||
|
|
|
||
|
|
If provided a `string`, the function returns `true`.
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var bool = isArrayLike( 'beep' );
|
||
|
|
// returns true
|
||
|
|
```
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.usage -->
|
||
|
|
|
||
|
|
<section class="examples">
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
<!-- eslint-disable object-curly-newline, no-restricted-syntax, no-empty-function -->
|
||
|
|
|
||
|
|
<!-- eslint no-undef: "error" -->
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var isArrayLike = require( '@stdlib/assert/is-array-like' );
|
||
|
|
|
||
|
|
var bool = isArrayLike( { 'length': 10 } );
|
||
|
|
// returns true
|
||
|
|
|
||
|
|
bool = isArrayLike( [] );
|
||
|
|
// returns true
|
||
|
|
|
||
|
|
bool = isArrayLike( 'beep' );
|
||
|
|
// returns true
|
||
|
|
|
||
|
|
bool = (function test() {
|
||
|
|
return isArrayLike( arguments );
|
||
|
|
})();
|
||
|
|
// returns true
|
||
|
|
|
||
|
|
bool = isArrayLike( null );
|
||
|
|
// returns false
|
||
|
|
|
||
|
|
bool = isArrayLike( void 0 );
|
||
|
|
// returns false
|
||
|
|
|
||
|
|
bool = isArrayLike( 5 );
|
||
|
|
// returns false
|
||
|
|
|
||
|
|
bool = isArrayLike( true );
|
||
|
|
// returns false
|
||
|
|
|
||
|
|
bool = isArrayLike( {} );
|
||
|
|
// returns false
|
||
|
|
|
||
|
|
bool = isArrayLike( function noop() {} );
|
||
|
|
// returns false
|
||
|
|
```
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.examples -->
|
||
|
|
|
||
|
|
<section class="links">
|
||
|
|
|
||
|
|
[array-like]: http://www.2ality.com/2013/05/quirk-array-like-objects.html
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.links -->
|