#355 Support BigInt argument

MikeMcl · MikeMcl · commit 997c74849940 · 2025-04-03T19:25:00.000+01:00
diff --git a/bignumber.d.ts b/bignumber.d.ts
@@ -320,7 +320,7 @@ declare namespace BigNumber {
   type Constructor = typeof BigNumber;
   type ModuloMode = 0 | 1 | 3 | 6 | 9;
   type RoundingMode = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8;
-  type Value = string | number | Instance;
+  type Value = string | number | bigint | Instance;
 }
 
 declare class BigNumber implements BigNumber.Instance {
@@ -339,7 +339,7 @@ declare class BigNumber implements BigNumber.Instance {
 
   /**
    * Returns a new instance of a BigNumber object with value `n`, where `n` is a numeric value in
-   * the specified `base`, or base 10 if `base` is omitted or is `null` or `undefined`.
+   * the specified `base`, or base 10 if `base` is omitted.
    *
    * ```ts
    * x = new BigNumber(123.4567)              // '123.4567'
@@ -487,11 +487,10 @@ declare class BigNumber implements BigNumber.Instance {
    * Returns a BigNumber whose value is the value of this BigNumber rounded by rounding mode
    * `roundingMode` to a maximum of `decimalPlaces` decimal places.
    *
-   * If `decimalPlaces` is omitted, or is `null` or `undefined`, the return value is the number of
-   * decimal places of the value of this BigNumber, or `null` if the value of this BigNumber is
-   * ±`Infinity` or `NaN`.
+   * If `decimalPlaces` is omitted, the return value is the number of decimal places of the value of
+   * this BigNumber, or `null` if the value of this BigNumber is ±`Infinity` or `NaN`.
    *
-   * If `roundingMode` is omitted, or is `null` or `undefined`, `ROUNDING_MODE` is used.
+   * If `roundingMode` is omitted, `ROUNDING_MODE` is used.
    *
    * Throws if `decimalPlaces` or `roundingMode` is invalid.
    *
@@ -520,11 +519,10 @@ declare class BigNumber implements BigNumber.Instance {
    * Returns a BigNumber whose value is the value of this BigNumber rounded by rounding mode
    * `roundingMode` to a maximum of `decimalPlaces` decimal places.
    *
-   * If `decimalPlaces` is omitted, or is `null` or `undefined`, the return value is the number of
-   * decimal places of the value of this BigNumber, or `null` if the value of this BigNumber is
-   * ±`Infinity` or `NaN`.
+   * If `decimalPlaces` is omitted, the return value is the number of decimal places of the value of
+   * this BigNumber, or `null` if the value of this BigNumber is ±`Infinity` or `NaN`.
    *
-   * If `roundingMode` is omitted, or is `null` or `undefined`, `ROUNDING_MODE` is used.
+   * If `roundingMode` is omitted, `ROUNDING_MODE` is used.
    *
    * Throws if `decimalPlaces` or `roundingMode` is invalid.
    *
@@ -689,7 +687,7 @@ declare class BigNumber implements BigNumber.Instance {
    * Returns a BigNumber whose value is the value of this BigNumber rounded to an integer using
    * rounding mode `rm`.
    *
-   * If `rm` is omitted, or is `null` or `undefined`, `ROUNDING_MODE` is used.
+   * If `rm` is omitted, `ROUNDING_MODE` is used.
    *
    * Throws if `rm` is invalid.
    *
@@ -1118,7 +1116,7 @@ declare class BigNumber implements BigNumber.Instance {
    * Returns a BigNumber whose value is the value of this BigNumber rounded to a precision of
    * `significantDigits` significant digits using rounding mode `roundingMode`.
    *
-   * If `roundingMode` is omitted or is `null` or `undefined`, `ROUNDING_MODE` will be used.
+   * If `roundingMode` is omitted, `ROUNDING_MODE` will be used.
    *
    * Throws if `significantDigits` or `roundingMode` is invalid.
    *
@@ -1162,7 +1160,7 @@ declare class BigNumber implements BigNumber.Instance {
    * Returns a BigNumber whose value is the value of this BigNumber rounded to a precision of
    * `significantDigits` significant digits using rounding mode `roundingMode`.
    *
-   * If `roundingMode` is omitted or is `null` or `undefined`, `ROUNDING_MODE` will be used.
+   * If `roundingMode` is omitted, `ROUNDING_MODE` will be used.
    *
    * Throws if `significantDigits` or `roundingMode` is invalid.
    *
@@ -1240,11 +1238,10 @@ declare class BigNumber implements BigNumber.Instance {
    * If the value of this BigNumber in exponential notation has fewer than `decimalPlaces` fraction
    * digits, the return value will be appended with zeros accordingly.
    *
-   * If `decimalPlaces` is omitted, or is `null` or `undefined`, the number of digits after the
-   * decimal point defaults to the minimum number of digits necessary to represent the value
-   * exactly.
+   * If `decimalPlaces` is omitted, the number of digits after the decimal point defaults to the
+   * minimum number of digits necessary to represent the value exactly.
    *
-   * If `roundingMode` is omitted or is `null` or `undefined`, `ROUNDING_MODE` is used.
+   * If `roundingMode` is omitted, `ROUNDING_MODE` is used.
    *
    * Throws if `decimalPlaces` or `roundingMode` is invalid.
    *
@@ -1278,12 +1275,12 @@ declare class BigNumber implements BigNumber.Instance {
    * Unlike `Number.prototype.toFixed`, which returns exponential notation if a number is greater or
    * equal to 10**21, this method will always return normal notation.
    *
-   * If `decimalPlaces` is omitted or is `null` or `undefined`, the return value will be unrounded
-   * and in normal notation. This is also unlike `Number.prototype.toFixed`, which returns the value
-   * to zero decimal places. It is useful when normal notation is required and the current
-   * `EXPONENTIAL_AT` setting causes `toString` to return exponential notation.
+   * If `decimalPlaces` is omitted, the return value will be unrounded and in normal notation.
+   * This is also unlike `Number.prototype.toFixed`, which returns the value to zero decimal places.
+   * It is useful when normal notation is required and the current `EXPONENTIAL_AT` setting causes
+   * `toString` to return exponential notation.
    *
-   * If `roundingMode` is omitted or is `null` or `undefined`, `ROUNDING_MODE` is used.
+   * If `roundingMode` is omitted, `ROUNDING_MODE` is used.
    *
    * Throws if `decimalPlaces` or `roundingMode` is invalid.
    *
@@ -1313,12 +1310,12 @@ declare class BigNumber implements BigNumber.Instance {
    *
    * The formatting object may contain some or all of the properties shown in the examples below.
    *
-   * If `decimalPlaces` is omitted or is `null` or `undefined`, then the return value is not
-   * rounded to a fixed number of decimal places.
+   * If `decimalPlaces` is omitted, then the return value is not rounded to a fixed number of
+   * decimal places.
    *
-   * If `roundingMode` is omitted or is `null` or `undefined`, `ROUNDING_MODE` is used.
+   * If `roundingMode` is omitted, `ROUNDING_MODE` is used.
    *
-   * If `format` is omitted or is `null` or `undefined`, `FORMAT` is used.
+   * If `format` is omitted, `FORMAT` is used.
    *
    * Throws if `decimalPlaces`, `roundingMode`, or `format` is invalid.
    *
@@ -1374,8 +1371,8 @@ declare class BigNumber implements BigNumber.Instance {
    * Returns an array of two BigNumbers representing the value of this BigNumber as a simple
    * fraction with an integer numerator and an integer denominator.
    * The denominator will be a positive non-zero value less than or equal to `max_denominator`.
-   * If a maximum denominator, `max_denominator`, is not specified, or is `null` or `undefined`, the
-   * denominator will be the lowest value necessary to represent the number exactly.
+   * If a maximum denominator, `max_denominator`, is not specified, the denominator will be the
+   * lowest value necessary to represent the number exactly.
    *
    * Throws if `max_denominator` is invalid.
    *
@@ -1426,10 +1423,9 @@ declare class BigNumber implements BigNumber.Instance {
    * If `significantDigits` is less than the number of digits necessary to represent the integer
    * part of the value in normal (fixed-point) notation, then exponential notation is used.
    *
-   * If `significantDigits` is omitted, or is `null` or `undefined`, then the return value is the
-   * same as `n.toString()`.
+   * If `significantDigits` is omitted, then the return value is the same as `n.toString()`.
    *
-   * If `roundingMode` is omitted or is `null` or `undefined`, `ROUNDING_MODE` is used.
+   * If `roundingMode` is omitted, `ROUNDING_MODE` is used.
    *
    * Throws if `significantDigits` or `roundingMode` is invalid.
    *
@@ -1454,7 +1450,7 @@ declare class BigNumber implements BigNumber.Instance {
 
   /**
    * Returns a string representing the value of this BigNumber in base `base`, or base 10 if `base`
-   * is omitted or is `null` or `undefined`.
+   * is omitted.
    *
    * For bases above 10, and using the default base conversion alphabet (see `ALPHABET`), values
    * from 10 to 35 are represented by a-z (the same as `Number.prototype.toString`).
@@ -1467,8 +1463,6 @@ declare class BigNumber implements BigNumber.Instance {
    * exponent equal to or less than the negative component of the setting, then exponential notation
    * is returned.
    *
-   * If `base` is `null` or `undefined` it is ignored.
-   *
    * Throws if `base` is invalid.
    *
    * ```ts
@@ -1588,7 +1582,7 @@ declare class BigNumber implements BigNumber.Instance {
 
   /**
    * Returns a new independent BigNumber constructor with configuration as described by `object`, or
-   * with the default configuration if object is `null` or `undefined`.
+   * with the default configuration if object is omitted.
    *
    * Throws if `object` is not an object.
    *

Original file line number	Diff line number	Diff line change
`@@ -320,7 +320,7 @@ declare namespace BigNumber {`
`320`	`320`	`type Constructor = typeof BigNumber;`
`321`	`321`	`type ModuloMode = 0 \| 1 \| 3 \| 6 \| 9;`
`322`	`322`	`type RoundingMode = 0 \| 1 \| 2 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8;`
`323`		`- type Value = string \| number \| Instance;`
	`323`	`+ type Value = string \| number \| bigint \| Instance;`
`324`	`324`	`}`
`325`	`325`
`326`	`326`	`declare class BigNumber implements BigNumber.Instance {`
`@@ -339,7 +339,7 @@ declare class BigNumber implements BigNumber.Instance {`
`339`	`339`
`340`	`340`	`/**`
`341`	`341`	* Returns a new instance of a BigNumber object with value `n`, where `n` is a numeric value in
`342`		- * the specified `base`, or base 10 if `base` is omitted or is `null` or `undefined`.
	`342`	+ * the specified `base`, or base 10 if `base` is omitted.
`343`	`343`	`*`
`344`	`344`	* ```ts
`345`	`345`	`* x = new BigNumber(123.4567) // '123.4567'`
`@@ -487,11 +487,10 @@ declare class BigNumber implements BigNumber.Instance {`
`487`	`487`	`* Returns a BigNumber whose value is the value of this BigNumber rounded by rounding mode`
`488`	`488`	* `roundingMode` to a maximum of `decimalPlaces` decimal places.
`489`	`489`	`*`
`490`		- * If `decimalPlaces` is omitted, or is `null` or `undefined`, the return value is the number of
`491`		- * decimal places of the value of this BigNumber, or `null` if the value of this BigNumber is
`492`		- * ±`Infinity` or `NaN`.
	`490`	+ * If `decimalPlaces` is omitted, the return value is the number of decimal places of the value of
	`491`	+ * this BigNumber, or `null` if the value of this BigNumber is ±`Infinity` or `NaN`.
`493`	`492`	`*`
`494`		- * If `roundingMode` is omitted, or is `null` or `undefined`, `ROUNDING_MODE` is used.
	`493`	+ * If `roundingMode` is omitted, `ROUNDING_MODE` is used.
`495`	`494`	`*`
`496`	`495`	* Throws if `decimalPlaces` or `roundingMode` is invalid.
`497`	`496`	`*`
`@@ -520,11 +519,10 @@ declare class BigNumber implements BigNumber.Instance {`
`520`	`519`	`* Returns a BigNumber whose value is the value of this BigNumber rounded by rounding mode`
`521`	`520`	* `roundingMode` to a maximum of `decimalPlaces` decimal places.
`522`	`521`	`*`
`523`		- * If `decimalPlaces` is omitted, or is `null` or `undefined`, the return value is the number of
`524`		- * decimal places of the value of this BigNumber, or `null` if the value of this BigNumber is
`525`		- * ±`Infinity` or `NaN`.
	`522`	+ * If `decimalPlaces` is omitted, the return value is the number of decimal places of the value of
	`523`	+ * this BigNumber, or `null` if the value of this BigNumber is ±`Infinity` or `NaN`.
`526`	`524`	`*`
`527`		- * If `roundingMode` is omitted, or is `null` or `undefined`, `ROUNDING_MODE` is used.
	`525`	+ * If `roundingMode` is omitted, `ROUNDING_MODE` is used.
`528`	`526`	`*`
`529`	`527`	* Throws if `decimalPlaces` or `roundingMode` is invalid.
`530`	`528`	`*`
`@@ -689,7 +687,7 @@ declare class BigNumber implements BigNumber.Instance {`
`689`	`687`	`* Returns a BigNumber whose value is the value of this BigNumber rounded to an integer using`
`690`	`688`	* rounding mode `rm`.
`691`	`689`	`*`
`692`		- * If `rm` is omitted, or is `null` or `undefined`, `ROUNDING_MODE` is used.
	`690`	+ * If `rm` is omitted, `ROUNDING_MODE` is used.
`693`	`691`	`*`
`694`	`692`	* Throws if `rm` is invalid.
`695`	`693`	`*`
`@@ -1118,7 +1116,7 @@ declare class BigNumber implements BigNumber.Instance {`
`1118`	`1116`	`* Returns a BigNumber whose value is the value of this BigNumber rounded to a precision of`
`1119`	`1117`	* `significantDigits` significant digits using rounding mode `roundingMode`.
`1120`	`1118`	`*`
`1121`		- * If `roundingMode` is omitted or is `null` or `undefined`, `ROUNDING_MODE` will be used.
	`1119`	+ * If `roundingMode` is omitted, `ROUNDING_MODE` will be used.
`1122`	`1120`	`*`
`1123`	`1121`	* Throws if `significantDigits` or `roundingMode` is invalid.
`1124`	`1122`	`*`
`@@ -1162,7 +1160,7 @@ declare class BigNumber implements BigNumber.Instance {`
`1162`	`1160`	`* Returns a BigNumber whose value is the value of this BigNumber rounded to a precision of`
`1163`	`1161`	* `significantDigits` significant digits using rounding mode `roundingMode`.
`1164`	`1162`	`*`
`1165`		- * If `roundingMode` is omitted or is `null` or `undefined`, `ROUNDING_MODE` will be used.
	`1163`	+ * If `roundingMode` is omitted, `ROUNDING_MODE` will be used.
`1166`	`1164`	`*`
`1167`	`1165`	* Throws if `significantDigits` or `roundingMode` is invalid.
`1168`	`1166`	`*`
`@@ -1240,11 +1238,10 @@ declare class BigNumber implements BigNumber.Instance {`
`1240`	`1238`	* If the value of this BigNumber in exponential notation has fewer than `decimalPlaces` fraction
`1241`	`1239`	`* digits, the return value will be appended with zeros accordingly.`
`1242`	`1240`	`*`
`1243`		- * If `decimalPlaces` is omitted, or is `null` or `undefined`, the number of digits after the
`1244`		`- * decimal point defaults to the minimum number of digits necessary to represent the value`
`1245`		`- * exactly.`
	`1241`	+ * If `decimalPlaces` is omitted, the number of digits after the decimal point defaults to the
	`1242`	`+ * minimum number of digits necessary to represent the value exactly.`
`1246`	`1243`	`*`
`1247`		- * If `roundingMode` is omitted or is `null` or `undefined`, `ROUNDING_MODE` is used.
	`1244`	+ * If `roundingMode` is omitted, `ROUNDING_MODE` is used.
`1248`	`1245`	`*`
`1249`	`1246`	* Throws if `decimalPlaces` or `roundingMode` is invalid.
`1250`	`1247`	`*`
`@@ -1278,12 +1275,12 @@ declare class BigNumber implements BigNumber.Instance {`
`1278`	`1275`	* Unlike `Number.prototype.toFixed`, which returns exponential notation if a number is greater or
`1279`	`1276`	`* equal to 10**21, this method will always return normal notation.`
`1280`	`1277`	`*`
`1281`		- * If `decimalPlaces` is omitted or is `null` or `undefined`, the return value will be unrounded
`1282`		- * and in normal notation. This is also unlike `Number.prototype.toFixed`, which returns the value
`1283`		`- * to zero decimal places. It is useful when normal notation is required and the current`
`1284`		- * `EXPONENTIAL_AT` setting causes `toString` to return exponential notation.
	`1278`	+ * If `decimalPlaces` is omitted, the return value will be unrounded and in normal notation.
	`1279`	+ * This is also unlike `Number.prototype.toFixed`, which returns the value to zero decimal places.
	`1280`	+ * It is useful when normal notation is required and the current `EXPONENTIAL_AT` setting causes
	`1281`	+ * `toString` to return exponential notation.
`1285`	`1282`	`*`
`1286`		- * If `roundingMode` is omitted or is `null` or `undefined`, `ROUNDING_MODE` is used.
	`1283`	+ * If `roundingMode` is omitted, `ROUNDING_MODE` is used.
`1287`	`1284`	`*`
`1288`	`1285`	* Throws if `decimalPlaces` or `roundingMode` is invalid.
`1289`	`1286`	`*`
`@@ -1313,12 +1310,12 @@ declare class BigNumber implements BigNumber.Instance {`
`1313`	`1310`	`*`
`1314`	`1311`	`* The formatting object may contain some or all of the properties shown in the examples below.`
`1315`	`1312`	`*`
`1316`		- * If `decimalPlaces` is omitted or is `null` or `undefined`, then the return value is not
`1317`		`- * rounded to a fixed number of decimal places.`
	`1313`	+ * If `decimalPlaces` is omitted, then the return value is not rounded to a fixed number of
	`1314`	`+ * decimal places.`
`1318`	`1315`	`*`
`1319`		- * If `roundingMode` is omitted or is `null` or `undefined`, `ROUNDING_MODE` is used.
	`1316`	+ * If `roundingMode` is omitted, `ROUNDING_MODE` is used.
`1320`	`1317`	`*`
`1321`		- * If `format` is omitted or is `null` or `undefined`, `FORMAT` is used.
	`1318`	+ * If `format` is omitted, `FORMAT` is used.
`1322`	`1319`	`*`
`1323`	`1320`	* Throws if `decimalPlaces`, `roundingMode`, or `format` is invalid.
`1324`	`1321`	`*`
`@@ -1374,8 +1371,8 @@ declare class BigNumber implements BigNumber.Instance {`
`1374`	`1371`	`* Returns an array of two BigNumbers representing the value of this BigNumber as a simple`
`1375`	`1372`	`* fraction with an integer numerator and an integer denominator.`
`1376`	`1373`	* The denominator will be a positive non-zero value less than or equal to `max_denominator`.
`1377`		- * If a maximum denominator, `max_denominator`, is not specified, or is `null` or `undefined`, the
`1378`		`- * denominator will be the lowest value necessary to represent the number exactly.`
	`1374`	+ * If a maximum denominator, `max_denominator`, is not specified, the denominator will be the
	`1375`	`+ * lowest value necessary to represent the number exactly.`
`1379`	`1376`	`*`
`1380`	`1377`	* Throws if `max_denominator` is invalid.
`1381`	`1378`	`*`
`@@ -1426,10 +1423,9 @@ declare class BigNumber implements BigNumber.Instance {`
`1426`	`1423`	* If `significantDigits` is less than the number of digits necessary to represent the integer
`1427`	`1424`	`* part of the value in normal (fixed-point) notation, then exponential notation is used.`
`1428`	`1425`	`*`
`1429`		- * If `significantDigits` is omitted, or is `null` or `undefined`, then the return value is the
`1430`		- * same as `n.toString()`.
	`1426`	+ * If `significantDigits` is omitted, then the return value is the same as `n.toString()`.
`1431`	`1427`	`*`
`1432`		- * If `roundingMode` is omitted or is `null` or `undefined`, `ROUNDING_MODE` is used.
	`1428`	+ * If `roundingMode` is omitted, `ROUNDING_MODE` is used.
`1433`	`1429`	`*`
`1434`	`1430`	* Throws if `significantDigits` or `roundingMode` is invalid.
`1435`	`1431`	`*`
`@@ -1454,7 +1450,7 @@ declare class BigNumber implements BigNumber.Instance {`
`1454`	`1450`
`1455`	`1451`	`/**`
`1456`	`1452`	* Returns a string representing the value of this BigNumber in base `base`, or base 10 if `base`
`1457`		- * is omitted or is `null` or `undefined`.
	`1453`	`+ * is omitted.`
`1458`	`1454`	`*`
`1459`	`1455`	* For bases above 10, and using the default base conversion alphabet (see `ALPHABET`), values
`1460`	`1456`	* from 10 to 35 are represented by a-z (the same as `Number.prototype.toString`).
`@@ -1467,8 +1463,6 @@ declare class BigNumber implements BigNumber.Instance {`
`1467`	`1463`	`* exponent equal to or less than the negative component of the setting, then exponential notation`
`1468`	`1464`	`* is returned.`
`1469`	`1465`	`*`
`1470`		- * If `base` is `null` or `undefined` it is ignored.
`1471`		`- *`
`1472`	`1466`	* Throws if `base` is invalid.
`1473`	`1467`	`*`
`1474`	`1468`	* ```ts
`@@ -1588,7 +1582,7 @@ declare class BigNumber implements BigNumber.Instance {`
`1588`	`1582`
`1589`	`1583`	`/**`
`1590`	`1584`	* Returns a new independent BigNumber constructor with configuration as described by `object`, or
`1591`		- * with the default configuration if object is `null` or `undefined`.
	`1585`	`+ * with the default configuration if object is omitted.`
`1592`	`1586`	`*`
`1593`	`1587`	* Throws if `object` is not an object.
`1594`	`1588`	`*`