1.0.1 • Published 6 years ago

@fav/type.to-number v1.0.1

Weekly downloads
3
License
MIT
Repository
github
Last release
6 years ago

@fav/type.to-number NPM version MIT License Build Status Build Status Coverage status

Converts a number or a string to a 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-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-number/ directory manually.

Usage

For Node.js:

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

For Web browsers:

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

API

toNumber(value , defaultValue): number

Converts a number or a string to a number. If value is neither a 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:

ParameterTypeDescription
valueanyThe number or string to be converted.
defaultValueanyIs returned when failing to convert. (Optional)

Returns:

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

Type: number

Checked

Node.js (4〜)

Platform45678910
macOS
Windows10
Linux

io.js (1〜3)

Platform123
macOS
Windows10
Linux

Node.js (〜0.12)

Platform0.80.90.100.110.12
macOS
Windows10
Linux

Web browsers

PlatformChromeFirefoxVivaldiSafariEdgeIE11
macOS----
Windows10--
Linux------

License

Copyright (C) 2018 Takayuki Sato

This program is free software under MIT License. See the file LICENSE in this distribution for more details.