Package Exports

@stdlib/assert-is-number-array

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/assert-is-number-array) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

isNumberArray

Test if a value is an array-like object of numbers.

Installation

npm install @stdlib/assert-is-number-array

Usage

var isNumberArray = require( '@stdlib/assert-is-number-array' );

isNumberArray( value )

Tests if a value is an array-like object of numbers.

var bool = isNumberArray( [ 1, 2, 3, 4 ] );
// returns true

isNumberArray.primitives( value )

Tests if a value is an array-like object containing only number primitives.

var Number = require( '@stdlib/number-ctor' );

var bool = isNumberArray.primitives( [ 1, 2, 3 ] );
// returns true

bool = isNumberArray.primitives( [ 1, new Number( 2 ), 3 ] );
// returns false

isNumberArray.objects( value )

Tests if a value is an array-like object containing only Number objects.

var Number = require( '@stdlib/number-ctor' );

var bool = isNumberArray.objects( [ new Number( 1 ), new Number( 2 ) ] );
// returns true

bool = isNumberArray.objects( [ new Number( 1 ), 2 ] );
// returns false

Examples

var Number = require( '@stdlib/number-ctor' );
var isNumberArray = require( '@stdlib/assert-is-number-array' );

var bool = isNumberArray( [ 3.14 ] );
// returns true

bool = isNumberArray( [ NaN ] );
// returns true

bool = isNumberArray( [ 1, 2, 3 ] );
// returns true

bool = isNumberArray( [ new Number( 3.14 ), 2, 3 ] );
// returns true

bool = isNumberArray( 3.14 );
// returns false

bool = isNumberArray( [] );
// returns false

bool = isNumberArray( [ '1', 2 ] );
// returns false

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

License

See LICENSE.

@stdlib/assert-is-number-array