@fav/type.to-finite-number

Converts a number or a string to a finite number.

"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.to-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.to-finite-number/ directory manually.

Usage

For Node.js:

var toFiniteNumber = require('@fav/type.to-finite-number');
toFiniteNumber(123); // => 123
toFiniteNumber('45.6'); // => 45.6
toFiniteNumber(Infinity); // => NaN
toFiniteNumber('ABC'); // =>> NaN
toFiniteNumber('ABC', 100); // => 100

For Web browsers:

<script src="fav.type.to-finite-number.min.js"></script>
<script>
var toFiniteNumber = fav.type.toFiniteNumber;
toFiniteNumber(123); // => 123
</script>

API

toFiniteNumber(value [, defaultValue]): number

Converts a number or a string to a finite number. If value is neither a finite number nor a numeric string, this function returns NaN, or defaultValue if specified.

NOTE: Number('') and Number(' ') return 0. parseInt(' 123'), parseInt('123abc'), parseFloat(' 123') and parseFloat('123abc') return 123. However, this function returns NaN in all such cases.

Parameter:

| Parameter | Type | Description | |----------------|:------:|---------------------------------------| | value | any | The number or string to be converted. | | defaultValue | any | Is returned when failing to convert. (Optional) |

Returns:

The converted finite number, or NaN (or defaultValue if specified) when failing to convert.

Type: number

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.