5.2 KiB
parse-int-x
Parses a string argument and returns an integer of the specified radix.
Version: 2.0.0
Author: Xotic750 Xotic750@gmail.com
License: MIT
Copyright: Xotic750
- parse-int-x
.parseInt.parseInt2016⇒number.parseInt2018⇒number
parse-int-x.parseInt
Reference to parseInt2018.
Kind: static property of parse-int-x
parse-int-x.parseInt2016 ⇒ number
This method parses a string argument and returns an integer of the specified radix (the base in mathematical numeral systems). (ES2016)
Kind: static property of parse-int-x
Returns: number - An integer number parsed from the given string. If the first
character cannot be converted to a number, NaN is returned.
Throws:
TypeErrorIf target is a Symbol or is not coercible.
| Param | Type | Description |
|---|---|---|
| string | string |
The value to parse. If the string argument is not a string, then it is converted to a string (using the ToString abstract operation). Leading whitespace in the string argument is ignored. |
| radix | number |
An integer between 2 and 36 that represents the radix (the base in mathematical numeral systems) of the above mentioned string. Specify 10 for the decimal numeral system commonly used by humans. Always specify this parameter to eliminate reader confusion and to guarantee predictable behavior. Different implementations produce different results when a radix is not specified, usually defaulting the value to 10. |
Example
var $parseInt = require('parse-int-x').parseInt2016;
// The following examples all return 15
$parseInt(' 0xF', 16);
$parseInt(' F', 16);
$parseInt('17', 8);
$parseInt(021, 8);
$parseInt('015', 10); // $parseInt(015, 10); will return 15
$parseInt(15.99, 10);
$parseInt('15,123', 10);
$parseInt('FXX123', 16);
$parseInt('1111', 2);
$parseInt('15 * 3', 10);
$parseInt('15e2', 10);
$parseInt('15px', 10);
$parseInt('12', 13);
//The following examples all return NaN:
$parseInt('Hello', 8); // Not a number at all
$parseInt('546', 2); // Digits are not valid for binary representations
parse-int-x.parseInt2018 ⇒ number
This method parses a string argument and returns an integer of the specified radix (the base in mathematical numeral systems). (ES2018)
Kind: static property of parse-int-x
Returns: number - An integer number parsed from the given string. If the first
character cannot be converted to a number, NaN is returned.
Throws:
TypeErrorIf target is a Symbol or is not coercible.
| Param | Type | Description |
|---|---|---|
| string | string |
The value to parse. If the string argument is not a string, then it is converted to a string (using the ToString abstract operation). Leading whitespace in the string argument is ignored. |
| radix | number |
An integer between 2 and 36 that represents the radix (the base in mathematical numeral systems) of the above mentioned string. Specify 10 for the decimal numeral system commonly used by humans. Always specify this parameter to eliminate reader confusion and to guarantee predictable behavior. Different implementations produce different results when a radix is not specified, usually defaulting the value to 10. |
Example
var $parseInt = require('parse-int-x').parseInt2018;
// The following examples all return 15
$parseInt(' 0xF', 16);
$parseInt(' F', 16);
$parseInt('17', 8);
$parseInt(021, 8);
$parseInt('015', 10); // $parseInt(015, 10); will return 15
$parseInt(15.99, 10);
$parseInt('15,123', 10);
$parseInt('FXX123', 16);
$parseInt('1111', 2);
$parseInt('15 * 3', 10);
$parseInt('15e2', 10);
$parseInt('15px', 10);
$parseInt('12', 13);
//The following examples all return NaN:
$parseInt('Hello', 8); // Not a number at all
$parseInt('546', 2); // Digits are not valid for binary representations