@stdlib/assert-is-nan-array NPM

isNaNArray

Test if a value is an array-like object containing only NaN values.

Installation

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

Usage

var isNaNArray = require( '@stdlib/assert-is-nan-array' );

isNaNArray( value )

Tests if a value is an array-like object containing only NaN values.

var bool = isNaNArray( [ NaN, NaN, NaN ] );
// returns true

bool = isNaNArray( [ NaN, 2 ] );
// returns false

isNaNArray.primitives( value )

Tests if a value is an array-like object containing only primitive NaN values.

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

var bool = isNaNArray.primitives( [ NaN, NaN, NaN ] );
// returns true

bool = isNaNArray.primitives( [ NaN, new Number( NaN ) ] );
// returns false

isNaNArray.objects( value )

Tests if a value is an array-like object containing only object NaN values.

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

var bool = isNaNArray.objects( [ new Number( NaN ), new Number( NaN ) ] );
// returns true

bool = isNaNArray.objects( [ NaN, new Number( NaN ) ] );
// returns false

bool = isNaNArray.objects( [ NaN, NaN, NaN ] );
// returns false

Examples

var Number = require( '@stdlib/number-ctor' );
var Float64Array = require( '@stdlib/array-float64' );
var isNaNArray = require( '@stdlib/assert-is-nan-array' );

var bool = isNaNArray( [ NaN ] );
// returns true

bool = isNaNArray( [ NaN, NaN, NaN ] );
// returns true

bool = isNaNArray( [ new Number( NaN ), NaN, NaN ] );
// returns true

bool = isNaNArray( new Float64Array( [ NaN, NaN ] ) );
// returns true

bool = isNaNArray( NaN );
// returns false

bool = isNaNArray( [ 'a', 'b', 'c' ] );
// returns false

bool = isNaNArray( [ 'a', NaN ] );
// 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.