API Number

Number

Numeric conversion, numeric-boundary constants, and parsing helpers.

Script API Reference

Overview

Number converts values to an AuroraScript number and exposes the numeric-boundary constants plus the numeric checks and parsers. Input that cannot be converted produces NaN.

Number is callable, so Number(value) converts a value directly and always produces a primitive number rather than a wrapper object.

Important

NaN is not equal to itself, so value == Number.NaN is never true. Use Number.isNaN(value) to test for it.

Quick Reference

Member	Returns	Summary
Number([value])	number	Converts a value to a number.
Number.MAX_VALUE	number	Largest finite number.
Number.MIN_VALUE	number	Smallest positive number.
Number.MAX_SAFE_INTEGER	number	Largest safely representable integer.
Number.MIN_SAFE_INTEGER	number	Smallest safely representable integer.
Number.NaN	number	Not-a-Number constant.
Number.POSITIVE_INFINITY	number	Positive infinity.
Number.NEGATIVE_INFINITY	number	Negative infinity.
Number.isNaN(value)	boolean	Reports whether a value is NaN.
Number.isInteger(value)	boolean	Reports whether a value is an integer.
Number.isInfinity(value)	boolean	Reports whether a value is infinite.
Number.parseFloat(value)	number	Parses a floating-point number.
Number.parseInt(value)	number	Parses an integer.
number.toString([radix])	string	Formats the number as text.

Constructors

Number([value])

Parameters

Name	Type	Required	Description
value	any	No	Value to convert.

Returns

number — the converted number, or NaN when the conversion fails.

Example

return Number("42"); // 42

Constants

All Number constants are read-only numbers.

Constant	Type	Description
Number.MAX_VALUE	number	Largest finite number the runtime can represent.
Number.MIN_VALUE	number	Smallest positive number the runtime can represent.
Number.MAX_SAFE_INTEGER	number	Largest integer that can be represented exactly.
Number.MIN_SAFE_INTEGER	number	Smallest integer that can be represented exactly.
Number.NaN	number	Not-a-Number constant.
Number.POSITIVE_INFINITY	number	Positive infinity.
Number.NEGATIVE_INFINITY	number	Negative infinity.

Example

var withinSafeRange = Number.MAX_SAFE_INTEGER > 0 && Number.MIN_SAFE_INTEGER < 0;
var bounded = Number.NEGATIVE_INFINITY < Number.MIN_VALUE && Number.MAX_VALUE < Number.POSITIVE_INFINITY;
return withinSafeRange && bounded && Number.isNaN(Number.NaN); // true

Methods

Number.isNaN(value)

Parameters

Name	Type	Required	Description
value	number	Yes	Value to inspect.

Returns

boolean — whether the value is NaN.

Example

return Number.isNaN(Number("not a number")); // true

Number.isInteger(value)

Parameters

Name	Type	Required	Description
value	number	Yes	Value to inspect.

Returns

boolean — whether the value is an integer.

Example

return Number.isInteger(42); // true

Number.isInfinity(value)

Parameters

Name	Type	Required	Description
value	number	Yes	Value to inspect.

Returns

boolean — whether the value is positive or negative infinity.

Example

return Number.isInfinity(Number.POSITIVE_INFINITY); // true

Number.parseFloat(value)

Parameters

Name	Type	Required	Description
value	string or number	Yes	Text or number to parse.

Returns

number — the parsed floating-point value, or NaN when parsing fails.

Example

return Number.parseFloat("3.14"); // 3.14

Number.parseInt(value)

Parameters

Name	Type	Required	Description
value	string or number	Yes	Text or number to parse.

Returns

number — the parsed integer, or NaN when parsing fails.

Example

return Number.parseInt("42"); // 42

number.toString([radix])

Parameters

Name	Type	Required	Description
radix	number	No	Base used to format the number.

Returns

string — the formatted number.

Example

return (42).toString(); // "42"