Home Original page

stdlib/lib/node_modules/@stdlib/assert/is-nan-array at develop · stdlib-js/stdlib

isNaNArray

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

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

See Also