@stdlib/math-base-assert-is-nan

What is @stdlib/math-base-assert-is-nan?

@stdlib/math-base-assert-is-nan is a utility package that provides a function to check if a value is NaN (Not-a-Number). This is useful in various mathematical and data validation contexts where you need to ensure that the values you're working with are valid numbers.

What are @stdlib/math-base-assert-is-nan's main functionalities?

Check if a value is NaN

This feature allows you to check if a given value is NaN. The function returns true if the value is NaN and false otherwise.

const isNaN = require('@stdlib/math-base-assert-is-nan');

console.log(isNaN(NaN)); // true
console.log(isNaN(5)); // false
console.log(isNaN('hello')); // false

Other packages similar to @stdlib/math-base-assert-is-nan

is-nan

The 'is-nan' package provides a similar functionality to check if a value is NaN. It is a lightweight package that offers a straightforward way to determine if a value is NaN. Compared to @stdlib/math-base-assert-is-nan, it offers a more minimalistic approach without additional utilities.

lodash

Lodash is a popular utility library that includes a function _.isNaN to check if a value is NaN. While Lodash provides a broader range of utilities beyond just checking for NaN, it is a larger library and may be overkill if you only need the NaN-checking functionality.

number-is-nan

The 'number-is-nan' package is a ponyfill for Number.isNaN, which is a more reliable way to check for NaN values compared to the global isNaN function. It is a small and focused package, similar to @stdlib/math-base-assert-is-nan, but specifically designed to replicate the behavior of Number.isNaN.

README

isnan

Test if a double-precision floating-point numeric value is NaN.

Installation

npm install @stdlib/math-base-assert-is-nan

Usage

var isnan = require( '@stdlib/math-base-assert-is-nan' );

isnan( x )

Tests if a double-precision floating-point numeric value is NaN.

var bool = isnan( NaN );
// returns true

Examples

var isnan = require( '@stdlib/math-base-assert-is-nan' );

var bool = isnan( NaN );
// returns true

bool = isnan( 5.0 );
// 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.

Copyright

Copyright © 2016-2021. The Stdlib Authors.