@fav/type.is-finite-number
v1.0.2
Published
Checks whether a value is a finite number or not.
Downloads
43
Maintainers
Readme
@fav/type.is-finite-number
Checks whether a value is a finite number or not.
"fav" is an abbreviation of "favorite" and also the acronym of "for all versions". This package is intended to support all Node.js versions and many browsers as possible. At least, this package supports Node.js >= v0.10 and major Web browsers: Chrome, Firefox, IE11, Edge, Vivaldi and Safari.
Install
To install from npm:
$ npm install --save @fav/type.is-finite-number
NOTE: npm < 2.7.0 does not support scoped package, but old version Node.js supports it. So when you use such older npm, you should download this package from github.com, and move it in node_modules/@fav/type.is-finite-number/
directory manually.
Usage
For Node.js:
var isFiniteNumber = require('@fav/type.is-finite-number');
isFiniteNumber(123); // => true
isFiniteNumber(4.56); // => true
isFiniteNumber(Infinity); // => false
isFiniteNumber(NaN); // => false
isFiniteNumber.not(123); // => false
isFiniteNumber.not(4.56); // => false
isFiniteNumber.not(Infinity); // => true
isFiniteNumber.not(NaN); // => true
For Web browsers:
<script src="fav.type.is-finite-number.min.js"></script>
<script>
var isFiniteNumber = fav.type.isFiniteNumber;
isFiniteNumber(123); // => true
isFiniteNumber.not(123); // => false
</script>
API
isFiniteNumber(value) : boolean
Checks if value is a number, which is neither a positive/negative infinity nor NaN.
Parameter:
| Parameter | Type | Description | |-----------|:------:|--------------------------| | value | any | The value to be checked. |
Return:
True, if value is a finite number.
Type: boolean
isFiniteNumber.not(value) : boolean
Checks if value is not a finite number.
This function always returns a negative boolean of isFiniteNumber(value)
.
Parameter:
| Parameter | Type | Description | |-----------|:------:|--------------------------| | value | any | The value to be checked. |
Return:
True, if value is not a finite number.
Type: boolean
Checked
Node.js (4〜)
| Platform | 4 | 5 | 6 | 7 | 8 | 9 | 10 | |:---------:|:------:|:------:|:------:|:------:|:------:|:------:|:------:| | macOS |◯|◯|◯|◯|◯|◯|◯| | Windows10 |◯|◯|◯|◯|◯|◯|◯| | Linux |◯|◯|◯|◯|◯|◯|◯|
io.js (1〜3)
| Platform | 1 | 2 | 3 | |:---------:|:------:|:------:|:------:| | macOS |◯|◯|◯| | Windows10 |◯|◯|◯| | Linux |◯|◯|◯|
Node.js (〜0.12)
| Platform | 0.8 | 0.9 | 0.10 | 0.11 | 0.12 | |:---------:|:------:|:------:|:------:|:------:|:------:| | macOS |◯|◯|◯|◯|◯| | Windows10 |◯|◯|◯|◯|◯| | Linux |◯|◯|◯|◯|◯|
Web browsers
| Platform | Chrome | Firefox | Vivaldi | Safari | Edge | IE11 | |:---------:|:------:|:-------:|:-------:|:------:|:------:|:------:| | macOS |◯|◯ |◯ |◯| -- | -- | | Windows10 |◯|◯ |◯ | -- |◯|◯| | Linux |◯|◯ |◯ | -- | -- | -- |
License
Copyright (C) 2017-2018 Takayuki Sato
This program is free software under MIT License. See the file LICENSE in this distribution for more details.