# isInteger
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Test if a finite [double-precision floating-point number][ieee754] is an integer.
## Installation
```bash
npm install @stdlib/math-base-assert-is-integer
```
## Usage
```javascript
var isInteger = require( '@stdlib/math-base-assert-is-integer' );
```
#### isInteger( x )
Tests if a finite [double-precision floating-point number][ieee754] is an `integer`.
```javascript
var bool = isInteger( 1.0 );
// returns true
```
## Notes
- The function assumes a **finite** `number`. If provided positive or negative `infinity`, the function will return `true`, when, in fact, the result is undefined. If `x` can be `infinite`, wrap the implementation as follows:
```javascript
function check( x ) {
return (
x < Infinity &&
x > -Infinity &&
isInteger( x )
);
}
var bool = check( Infinity );
// returns false
bool = check( -Infinity );
// returns false
```
## Examples
```javascript
var isInteger = require( '@stdlib/math-base-assert-is-integer' );
var bool = isInteger( -5.0 );
// returns true
bool = isInteger( 3.14 );
// returns false
bool = isInteger( 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/math-base-assert-is-integer.svg
[npm-url]: https://npmjs.org/package/@stdlib/math-base-assert-is-integer
[test-image]: https://github.com/stdlib-js/math-base-assert-is-integer/actions/workflows/test.yml/badge.svg
[test-url]: https://github.com/stdlib-js/math-base-assert-is-integer/actions/workflows/test.yml
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-base-assert-is-integer/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/math-base-assert-is-integer?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/math-base-assert-is-integer/tree/deno
[umd-url]: https://github.com/stdlib-js/math-base-assert-is-integer/tree/umd
[esm-url]: https://github.com/stdlib-js/math-base-assert-is-integer/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/math-base-assert-is-integer/main/LICENSE
[ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985