parseInt
The parseInt()
function parses a string argument and returns an integer of the specified radix (the base in mathematical numeral systems).
Syntax
parseInt(string)
parseInt(string, radix)
Parameters
string
- : A string starting with an integer. Leading whitespace in this argument is ignored.
radix
optional- : An integer between
2
and36
that represents the radix (the base in mathematical numeral systems) of thestring
. It is converted to a 32-bit integer; if it's outside the range of [2, 36] after conversion, the function will always returnNaN
. If0
or not provided, the radix will be inferred based onstring
's value. Be careful — this does NOT always default to10
! The description below explains in more detail what happens whenradix
is not provided.
- : An integer between
Return value
An integer parsed from the given string
, or NaN
when
- the
radix
as a 32-bit integer is smaller than2
or bigger than36
, or - the first non-whitespace character cannot be converted to a number.
Note: JavaScript does not have the distinction of "floating point numbers" and "integers" on the language level.
parseInt()
andparseFloat()
only differ in their parsing behavior, but not necessarily their return values. For example,parseInt("42")
andparseFloat("42")
would return the same value: aNumber
42.
Description
The parseInt
function converts its first argument to a string, parses that string, then returns an integer or NaN
.
If not NaN
, the return value will be the integer that is the first argument taken as a number in the specified radix
. (For example, a radix
of 10
converts from a decimal number, 8
converts from octal, 16
from hexadecimal, and so on.)
The radix
argument is converted to a number. If it's unprovided, or if the value becomes 0, NaN
or Infinity
(undefined
is coerced to NaN
), JavaScript assumes the following:
- If the input
string
, with leading whitespace and possible+
/-
signs removed, begins with0x
or0X
(a zero, followed by lowercase or uppercase X),radix
is assumed to be16
and the rest of the string is parsed as a hexadecimal number. - If the input
string
begins with any other value, the radix is10
(decimal).
Note: Other prefixes like
0b
, which are valid in number literals, are treated as normal digits byparseInt()
.parseInt()
does not treat strings beginning with a0
character as octal values either. The only prefix thatparseInt()
recognizes is0x
or0X
for hexadecimal values — everything else is parsed as a decimal value ifradix
is missing.
If the radix is 16
, parseInt()
allows the string to be optionally prefixed by 0x
or 0X
after the optional sign character (+
/-
).
If the radix value (coerced if necessary) is not in range [2, 36] (inclusive) parseInt
returns NaN
.
For radices above 10
, letters of the English alphabet indicate numerals greater than 9
. For example, for hexadecimal numbers (base 16
), A
through F
are used. The letters are case-insensitive.
parseInt
understands exactly two signs: +
for positive, and -
for negative. It is done as an initial step in the parsing after whitespace is removed. If no signs are found, the algorithm moves to the following step; otherwise, it removes the sign and runs the number-parsing on the rest of the string.
If parseInt
encounters a character that is not a numeral in the specified radix
, it ignores it and all succeeding characters and returns the integer value parsed up to that point. For example, although 1e3
technically encodes an integer (and will be correctly parsed to the integer 1000
by parseFloat()
, parseInt("1e3", 10)
returns 1
, because e
is not a valid numeral in base 10. Because .
is not a numeral either, the return value will always be an integer.
If the first character cannot be converted to a number with the radix in use, parseInt
returns NaN
. Leading whitespace is allowed.
For arithmetic purposes, the NaN
value is not a number in any radix. You can call the Number.isNaN
function to determine if the result of parseInt
is NaN
. If NaN
is passed on to arithmetic operations, the operation result will also be NaN
.
Because large numbers use the e
character in their string representation (e.g. 6.022e23
for 6.022 × 1023), using parseInt
to truncate numbers will produce unexpected results when used on very large or very small numbers. parseInt
should not be used as a substitute for Math.trunc()
.
To convert a number to its string literal in a particular radix, use thatNumber.toString(radix)
.
Because parseInt()
returns a number, it may suffer from loss of precision if the integer represented by the string is outside the safe range. The BigInt
function supports parsing integers of arbitrary length accurately, by returning a BigInt
.