# isNaN
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Test if a value is NaN.
## Installation
```bash
npm install @stdlib/assert-is-nan
```
## Usage
```javascript
var isnan = require( '@stdlib/assert-is-nan' );
```
#### isnan( value )
Tests if a `value` is `NaN`.
```javascript
var Number = require( '@stdlib/number-ctor' );
var bool = isnan( NaN );
// returns true
bool = isnan( new Number( NaN ) );
// returns true
bool = isnan( 3.14 );
// returns false
bool = isnan( null );
// returns false
```
#### isnan.isPrimitive( value )
Tests if a `value` is a `NaN` primitive `number`.
```javascript
var Number = require( '@stdlib/number-ctor' );
var bool = isnan.isPrimitive( NaN );
// returns true
bool = isnan.isPrimitive( 3.14 );
// returns false
bool = isnan.isPrimitive( new Number( NaN ) );
// returns false
```
#### isnan.isObject( value )
Tests if a `value` is a `Number` object having a value of `NaN`.
```javascript
var Number = require( '@stdlib/number-ctor' );
var bool = isnan.isObject( NaN );
// returns false
bool = isnan.isObject( new Number( NaN ) );
// returns true
```
## Examples
```javascript
var Number = require( '@stdlib/number-ctor' );
var Symbol = require( '@stdlib/symbol-ctor' );
var isnan = require( '@stdlib/assert-is-nan' );
var bool = isnan( NaN );
// returns true
bool = isnan( new Number( NaN ) );
// returns true
bool = isnan( 5 );
// returns false
bool = isnan( '5' );
// returns false
bool = isnan( null );
// returns false
bool = isnan( Symbol( 'NaN' ) );
// returns false
```
* * *
## Notice
This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
## License
See [LICENSE][stdlib-license].
## Copyright
Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/assert-is-nan.svg
[npm-url]: https://npmjs.org/package/@stdlib/assert-is-nan
[test-image]: https://github.com/stdlib-js/assert-is-nan/actions/workflows/test.yml/badge.svg
[test-url]: https://github.com/stdlib-js/assert-is-nan/actions/workflows/test.yml
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/assert-is-nan/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/assert-is-nan?branch=main
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/assert-is-nan/tree/deno
[umd-url]: https://github.com/stdlib-js/assert-is-nan/tree/umd
[esm-url]: https://github.com/stdlib-js/assert-is-nan/tree/esm
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://gitter.im/stdlib-js/stdlib/
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/assert-is-nan/main/LICENSE
[@stdlib/assert/is-number]: https://www.npmjs.com/package/@stdlib/assert-is-number