139 lines
2.9 KiB
Markdown
139 lines
2.9 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.
|
||
|
|
|
||
|
|
-->
|
||
|
|
|
||
|
|
# isNumericArray
|
||
|
|
|
||
|
|
> Test if a value is a numeric array.
|
||
|
|
|
||
|
|
<section class="usage">
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var isNumericArray = require( '@stdlib/assert/is-numeric-array' );
|
||
|
|
```
|
||
|
|
|
||
|
|
#### isNumericArray( value )
|
||
|
|
|
||
|
|
Tests if a value is a numeric array.
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var Int8Array = require( '@stdlib/array/int8' );
|
||
|
|
|
||
|
|
var bool = isNumericArray( new Int8Array( 10 ) );
|
||
|
|
// returns true
|
||
|
|
|
||
|
|
bool = isNumericArray( [ 1, 2, 3 ] );
|
||
|
|
// returns true
|
||
|
|
|
||
|
|
bool = isNumericArray( [ '1', '2', '3' ] );
|
||
|
|
// returns false
|
||
|
|
```
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.usage -->
|
||
|
|
|
||
|
|
<section class="examples">
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
<!-- TODO: update once Buffer wrapper -->
|
||
|
|
|
||
|
|
<!-- eslint no-undef: "error" -->
|
||
|
|
|
||
|
|
<!-- eslint-disable no-buffer-constructor -->
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var Buffer = require( '@stdlib/buffer/ctor' );
|
||
|
|
var Int8Array = require( '@stdlib/array/int8' );
|
||
|
|
var Uint8Array = require( '@stdlib/array/uint8' );
|
||
|
|
var Uint8ClampedArray = require( '@stdlib/array/uint8c' );
|
||
|
|
var Int16Array = require( '@stdlib/array/int16' );
|
||
|
|
var Uint16Array = require( '@stdlib/array/uint16' );
|
||
|
|
var Int32Array = require( '@stdlib/array/int32' );
|
||
|
|
var Uint32Array = require( '@stdlib/array/uint32' );
|
||
|
|
var Float32Array = require( '@stdlib/array/float32' );
|
||
|
|
var Float64Array = require( '@stdlib/array/float64' );
|
||
|
|
var isNumericArray = require( '@stdlib/assert/is-numeric-array' );
|
||
|
|
|
||
|
|
var arr = new Int8Array( 10 );
|
||
|
|
var bool = isNumericArray( arr );
|
||
|
|
// returns true
|
||
|
|
|
||
|
|
arr = new Uint8Array( 10 );
|
||
|
|
bool = isNumericArray( arr );
|
||
|
|
// returns true
|
||
|
|
|
||
|
|
arr = new Uint8ClampedArray( 10 );
|
||
|
|
bool = isNumericArray( arr );
|
||
|
|
// returns true
|
||
|
|
|
||
|
|
arr = new Int16Array( 10 );
|
||
|
|
bool = isNumericArray( arr );
|
||
|
|
// returns true
|
||
|
|
|
||
|
|
arr = new Uint16Array( 10 );
|
||
|
|
bool = isNumericArray( arr );
|
||
|
|
// returns true
|
||
|
|
|
||
|
|
arr = new Int32Array( 10 );
|
||
|
|
bool = isNumericArray( arr );
|
||
|
|
// returns true
|
||
|
|
|
||
|
|
arr = new Uint32Array( 10 );
|
||
|
|
bool = isNumericArray( arr );
|
||
|
|
// returns true
|
||
|
|
|
||
|
|
arr = new Float32Array( 10 );
|
||
|
|
bool = isNumericArray( arr );
|
||
|
|
// returns true
|
||
|
|
|
||
|
|
arr = new Float64Array( 10 );
|
||
|
|
bool = isNumericArray( arr );
|
||
|
|
// returns true
|
||
|
|
|
||
|
|
arr = [ 1, 2, 3 ];
|
||
|
|
bool = isNumericArray( arr );
|
||
|
|
// returns true
|
||
|
|
|
||
|
|
bool = isNumericArray( [] );
|
||
|
|
// returns false
|
||
|
|
|
||
|
|
bool = isNumericArray( {} );
|
||
|
|
// returns false
|
||
|
|
|
||
|
|
bool = isNumericArray( null );
|
||
|
|
// returns false
|
||
|
|
|
||
|
|
bool = isNumericArray( new Buffer( 10 ) );
|
||
|
|
// returns false
|
||
|
|
```
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.examples -->
|
||
|
|
|
||
|
|
<section class="links">
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.links -->
|