@danielsimonjr/mathts-core 0.15.4 → 0.16.0

package/dist/bignumber-formatter.d.ts

@@ -1,29 +1,33 @@
 /**
  * Structural contract for the BigNumber values handled by this formatter.
- * Captures exactly the methods/properties used here. The configured BigNumber
- * implementation (e.g. decimal.js) provides these; the project's `BigNumber`
- * type alias points at a minimal local Decimal that does not declare them all,
- * so we model the runtime contract explicitly.
+ * Captures exactly the methods/properties used here, with the argument types this
+ * module actually passes. The configured BigNumber implementation (e.g. decimal.js)
+ * and core's own `BigNumber` both provide these.
+ *
+ * `Self` is the implementation's own type: the formatter only ever combines a value
+ * with numbers and with values of the same class (built through `ctorOf`). Typing an
+ * operand as `BigNumberValue` instead would demand that every implementation accept
+ * every other one, and neither decimal.js nor core's `BigNumber` does, so no real
+ * value was assignable and every export here was uncallable without a cast.
  */
-export interface BigNumberValue {
+export interface BigNumberValue<Self> {
     e: number;
-    constructor: new (value: number | string) => BigNumberValue;
     isFinite(): boolean;
     isNaN(): boolean;
     isZero(): boolean;
     isInteger(): boolean;
-    gt(other: number | BigNumberValue): boolean;
-    greaterThan(other: number | BigNumberValue): boolean;
-    lessThan(other: number | BigNumberValue): boolean;
-    add(other: number | BigNumberValue): BigNumberValue;
-    sub(other: number | BigNumberValue): BigNumberValue;
-    mul(other: number | BigNumberValue): BigNumberValue;
-    pow(exp: number | BigNumberValue): BigNumberValue;
+    gt(other: number): boolean;
+    greaterThan(other: number | Self): boolean;
+    lessThan(other: number | Self): boolean;
+    add(other: Self): Self;
+    sub(other: number): Self;
+    mul(other: number): Self;
+    pow(exp: number): Self;
     toNumber(): number;
     toFixed(places?: number): string;
     toExponential(places?: number): string;
     toPrecision(sd?: number): string;
-    toSignificantDigits(sd?: number): BigNumberValue;
+    toSignificantDigits(sd?: number): Self;
     toBinary(): string;
     toOctal(): string;
     toHexadecimal(): string;
@@ -115,7 +119,7 @@ export declare function format(value: unknown, options?: unknown): string;
  * @param value
  * @param precision - Optional number of significant figures to return.
  */
-export declare function toEngineering(value: BigNumberValue, precision?: number): string;
+export declare function toEngineering<T extends BigNumberValue<T>>(value: T, precision?: number): string;
 /**
  * Format a number in exponential notation. Like '1.23e+5', '2.3e+0', '3.500e-3'
  * @param value
@@ -124,12 +128,12 @@ export declare function toEngineering(value: BigNumberValue, precision?: number)
  *                              is used.
  * @returns str
  */
-export declare function toExponential(value: BigNumberValue, precision?: number): string;
+export declare function toExponential<T extends BigNumberValue<T>>(value: T, precision?: number): string;
 /**
  * Format a number with fixed notation.
  * @param value
  * @param precision - Optional number of decimals after the
  *                                       decimal point. Undefined by default.
  */
-export declare function toFixed(value: BigNumberValue, precision?: number): string;
+export declare function toFixed<T extends BigNumberValue<T>>(value: T, precision?: number): string;
 //# sourceMappingURL=bignumber-formatter.d.ts.map

package/dist/bignumber-formatter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"bignumber-formatter.d.ts","sourceRoot":"","sources":["../src/bignumber-formatter.ts"],"names":[],"mappings":"AAqBA;;;;;;GAMG;AACH,MAAM,WAAW,cAAc;IAC7B,CAAC,EAAE,MAAM,CAAC;IACV,WAAW,EAAE,KAAK,KAAK,EAAE,MAAM,GAAG,MAAM,KAAK,cAAc,CAAC;IAC5D,QAAQ,IAAI,OAAO,CAAC;IACpB,KAAK,IAAI,OAAO,CAAC;IACjB,MAAM,IAAI,OAAO,CAAC;IAClB,SAAS,IAAI,OAAO,CAAC;IACrB,EAAE,CAAC,KAAK,EAAE,MAAM,GAAG,cAAc,GAAG,OAAO,CAAC;IAC5C,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,cAAc,GAAG,OAAO,CAAC;IACrD,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,cAAc,GAAG,OAAO,CAAC;IAClD,GAAG,CAAC,KAAK,EAAE,MAAM,GAAG,cAAc,GAAG,cAAc,CAAC;IACpD,GAAG,CAAC,KAAK,EAAE,MAAM,GAAG,cAAc,GAAG,cAAc,CAAC;IACpD,GAAG,CAAC,KAAK,EAAE,MAAM,GAAG,cAAc,GAAG,cAAc,CAAC;IACpD,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,GAAG,cAAc,CAAC;IAClD,QAAQ,IAAI,MAAM,CAAC;IACnB,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACjC,aAAa,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACvC,WAAW,CAAC,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACjC,mBAAmB,CAAC,EAAE,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC;IACjD,QAAQ,IAAI,MAAM,CAAC;IACnB,OAAO,IAAI,MAAM,CAAC;IAClB,aAAa,IAAI,MAAM,CAAC;CACzB;AA2CD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgFG;AACH,wBAAgB,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,MAAM,CAkGhE;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,cAAc,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,CAe/E;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,cAAc,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,CAM/E;AAED;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,cAAc,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,CAEzE"}
+{"version":3,"file":"bignumber-formatter.d.ts","sourceRoot":"","sources":["../src/bignumber-formatter.ts"],"names":[],"mappings":"AAqBA;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,cAAc,CAAC,IAAI;IAClC,CAAC,EAAE,MAAM,CAAC;IACV,QAAQ,IAAI,OAAO,CAAC;IACpB,KAAK,IAAI,OAAO,CAAC;IACjB,MAAM,IAAI,OAAO,CAAC;IAClB,SAAS,IAAI,OAAO,CAAC;IACrB,EAAE,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC;IAC3B,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC;IAC3C,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC;IACxC,GAAG,CAAC,KAAK,EAAE,IAAI,GAAG,IAAI,CAAC;IACvB,GAAG,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,GAAG,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,QAAQ,IAAI,MAAM,CAAC;IACnB,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACjC,aAAa,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACvC,WAAW,CAAC,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACjC,mBAAmB,CAAC,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvC,QAAQ,IAAI,MAAM,CAAC;IACnB,OAAO,IAAI,MAAM,CAAC;IAClB,aAAa,IAAI,MAAM,CAAC;CACzB;AA4DD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgFG;AACH,wBAAgB,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,MAAM,CAkGhE;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,CAAC,SAAS,cAAc,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,CAe/F;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,CAAC,SAAS,cAAc,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,CAM/F;AAED;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,CAAC,SAAS,cAAc,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,CAEzF"}