[license-shield-url]: https://img.shields.io/github/license/typeforce-js/is-number.svg?style=flat-square
[license-url]: https://github.com/Typeforce-JS/is-number/blob/master/LICENSE
[npm-downloads-shield-url]: https://img.shields.io/npm/dt/@typeforce/is-number.svg?style=flat-square
[npm-version-shield-url]: https://img.shields.io/npm/v/@typeforce/is-number.svg?style=flat-square
[npm-url]: https://www.npmjs.com/package/@typeforce/is-number
[unpkg-shield-url]: https://img.shields.io/badge/unpkg-up--to--date-brightgreen.svg?style=flat-square
[unpkg-url]: https://unpkg.com/@typeforce/is-number/dist/index.min.js

is-number

[![NPM][npm-version-shield-url]][npm-url]
[![NPM][npm-downloads-shield-url]][npm-url]
[![CDN][unpkg-shield-url]][unpkg-url]
[![LICENSE][license-shield-url]][license-url]

Determine if a value is a number.

A value is a number if it is of primitive type number, or is an instance of
reference type Number.

Usage

``shell
npm install @typeforce/is-number --save # Install package via NPM
`

`javascript
import { expect } from "chai";
import isNumber from "@typeforce/is-number";

expect(isNumber(new Number(42))).to.be.true;
expect(isNumber(Number.POSITIVE_INFINITY)).to.be.true;
expect(isNumber(Number.NaN)).to.be.true;
expect(isNumber(42)).to.be.true;
expect(isNumber(0)).to.be.true;
expect(isNumber(-42)).to.be.true;

expect(isNumber(undefined)).to.be.false;
expect(isNumber(null)).to.be.false;
expect(isNumber("42").to.be.false;
`

This package contains TypeScript type declarations. Furthermore, the package
uses TypeScript type guards to allow type inference to influence IntelliSense.

`typescript
if (isNumber(x)) {
// IntelliSense now knows x is a number.
let y: number = x;
}
`

$3

This package can be imported via unpkg as demonstrated
below.

`html


`

Build & Test

When building the project, a folder named dist/ will be created if it does not
already exist, where the compiled code will be outputted to. Type declaration
files will also be generated and outputted to the dist/ folder.

A minified Javascript version of the entire project will be generated and
outputted to dist/index.min.js.

`shell
npm install # Installs dependencies.
npm run build # Build the project.
`

This package uses Gulp for building, and Chai
and Mocha for testing.

`shell
npm test # Run tests.
`

License

Refer to the LICENSE` file for license information.