@xylabs/decimal-precision 5.0.83 → 5.0.86

package/README.md

@@ -15,6 +15,8 @@
 
 Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
+
+
 ## Reference
 
 **@xylabs/decimal-precision**
@@ -23,9 +25,11 @@ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
 ## Functions
 
-- [fromFixedPoint](#functions/fromFixedPoint)
-- [toDecimalPrecision](#functions/toDecimalPrecision)
-- [toFixedPoint](#functions/toFixedPoint)
+| Function | Description |
+| ------ | ------ |
+| [fromFixedPoint](#functions/fromFixedPoint) | Converts a fixed-point bigint back to a whole-number bigint by dividing out the decimal places. |
+| [toDecimalPrecision](#functions/toDecimalPrecision) | Formats a number to the specified number of significant digits, returning a string with minimal trailing zeros. |
+| [toFixedPoint](#functions/toFixedPoint) | Converts a bigint or decimal string to a fixed-point bigint representation. |
 
 ### functions
 
@@ -36,23 +40,24 @@ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 ***
 
 ```ts
-function fromFixedPoint(value, places?): bigint;
+function fromFixedPoint(value: bigint, places?: number): bigint;
 ```
 
-## Parameters
+Converts a fixed-point bigint back to a whole-number bigint by dividing out the decimal places.
 
-### value
-
-`bigint`
-
-### places?
+## Parameters
 
-`number` = `18`
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `value` | `bigint` | `undefined` | The fixed-point bigint value to convert |
+| `places` | `number` | `18` | Number of decimal places (default 18) |
 
 ## Returns
 
 `bigint`
 
+The whole-number bigint result
+
   ### <a id="toDecimalPrecision"></a>toDecimalPrecision
 
 [**@xylabs/decimal-precision**](#../README)
@@ -60,23 +65,24 @@ function fromFixedPoint(value, places?): bigint;
 ***
 
 ```ts
-function toDecimalPrecision(value, digits): string;
+function toDecimalPrecision(value: number, digits: number): string;
 ```
 
-## Parameters
-
-### value
-
-`number`
+Formats a number to the specified number of significant digits, returning a string with minimal trailing zeros.
 
-### digits
+## Parameters
 
-`number`
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | `number` | The number to format |
+| `digits` | `number` | The number of significant digits |
 
 ## Returns
 
 `string`
 
+A string representation of the number with the specified precision
+
   ### <a id="toFixedPoint"></a>toFixedPoint
 
 [**@xylabs/decimal-precision**](#../README)
@@ -84,23 +90,24 @@ function toDecimalPrecision(value, digits): string;
 ***
 
 ```ts
-function toFixedPoint(value, places?): bigint;
+function toFixedPoint(value: string | bigint, places?: number): bigint;
 ```
 
-## Parameters
+Converts a bigint or decimal string to a fixed-point bigint representation.
 
-### value
-
-`string` | `bigint`
-
-### places?
+## Parameters
 
-`number` = `18`
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `value` | `string` \| `bigint` | `undefined` | The value to convert (bigint or string with optional decimal point) |
+| `places` | `number` | `18` | Number of decimal places (default 18) |
 
 ## Returns
 
 `bigint`
 
+A bigint representing the value scaled by 10^places
+
 
 Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
 

package/dist/neutral/fromFixedPoint.d.ts

@@ -1,2 +1,8 @@
+/**
+ * Converts a fixed-point bigint back to a whole-number bigint by dividing out the decimal places.
+ * @param value - The fixed-point bigint value to convert
+ * @param places - Number of decimal places (default 18)
+ * @returns The whole-number bigint result
+ */
 export declare const fromFixedPoint: (value: bigint, places?: number) => bigint;
 //# sourceMappingURL=fromFixedPoint.d.ts.map

package/dist/neutral/fromFixedPoint.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fromFixedPoint.d.ts","sourceRoot":"","sources":["../../src/fromFixedPoint.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,cAAc,GAAI,OAAO,MAAM,EAAE,eAAW,KAAG,MAG3D,CAAA"}
+{"version":3,"file":"fromFixedPoint.d.ts","sourceRoot":"","sources":["../../src/fromFixedPoint.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,eAAO,MAAM,cAAc,GAAI,OAAO,MAAM,EAAE,eAAW,KAAG,MAG3D,CAAA"}

package/dist/neutral/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/fromFixedPoint.ts","../../src/toDecimalPrecision.ts","../../src/toFixedPoint.ts"],"sourcesContent":["export const fromFixedPoint = (value: bigint, places = 18): bigint => {\n  if (!Number.isInteger(places)) throw new Error(`places (${places}) must be an Integer`)\n  return value / (10n ** BigInt(places))\n}\n","export const toDecimalPrecision = (value: number, digits: number) => {\n  let fixed = 0\n  const result = Number.parseFloat(value.toPrecision(digits))\n  while (Number.parseFloat(result.toFixed(fixed)) !== result && fixed < 20) {\n    fixed++\n  }\n  return result.toFixed(fixed)\n}\n","export const toFixedPoint = (value: bigint | string, places = 18): bigint => {\n  if (!Number.isInteger(places)) throw new Error(`places (${places}) must be an Integer`)\n  if (typeof value === 'string') {\n    const parts = value.split('.')\n    if (parts.length > 2) {\n      throw new Error('Too many decimals in value')\n    }\n    if (parts.length === 1) {\n      return BigInt(value) * (10n ** BigInt(places))\n    }\n    const [whole, fraction] = parts\n    const trimmed = fraction.slice(0, places)\n    return BigInt(whole + trimmed.padEnd(Number(places), '0'))\n  }\n  return value * (10n ** BigInt(places))\n}\n"],"mappings":";AAAO,IAAM,iBAAiB,CAAC,OAAe,SAAS,OAAe;AACpE,MAAI,CAAC,OAAO,UAAU,MAAM,EAAG,OAAM,IAAI,MAAM,WAAW,MAAM,sBAAsB;AACtF,SAAO,QAAS,OAAO,OAAO,MAAM;AACtC;;;ACHO,IAAM,qBAAqB,CAAC,OAAe,WAAmB;AACnE,MAAI,QAAQ;AACZ,QAAM,SAAS,OAAO,WAAW,MAAM,YAAY,MAAM,CAAC;AAC1D,SAAO,OAAO,WAAW,OAAO,QAAQ,KAAK,CAAC,MAAM,UAAU,QAAQ,IAAI;AACxE;AAAA,EACF;AACA,SAAO,OAAO,QAAQ,KAAK;AAC7B;;;ACPO,IAAM,eAAe,CAAC,OAAwB,SAAS,OAAe;AAC3E,MAAI,CAAC,OAAO,UAAU,MAAM,EAAG,OAAM,IAAI,MAAM,WAAW,MAAM,sBAAsB;AACtF,MAAI,OAAO,UAAU,UAAU;AAC7B,UAAM,QAAQ,MAAM,MAAM,GAAG;AAC7B,QAAI,MAAM,SAAS,GAAG;AACpB,YAAM,IAAI,MAAM,4BAA4B;AAAA,IAC9C;AACA,QAAI,MAAM,WAAW,GAAG;AACtB,aAAO,OAAO,KAAK,IAAK,OAAO,OAAO,MAAM;AAAA,IAC9C;AACA,UAAM,CAAC,OAAO,QAAQ,IAAI;AAC1B,UAAM,UAAU,SAAS,MAAM,GAAG,MAAM;AACxC,WAAO,OAAO,QAAQ,QAAQ,OAAO,OAAO,MAAM,GAAG,GAAG,CAAC;AAAA,EAC3D;AACA,SAAO,QAAS,OAAO,OAAO,MAAM;AACtC;","names":[]}
+{"version":3,"sources":["../../src/fromFixedPoint.ts","../../src/toDecimalPrecision.ts","../../src/toFixedPoint.ts"],"sourcesContent":["/**\n * Converts a fixed-point bigint back to a whole-number bigint by dividing out the decimal places.\n * @param value - The fixed-point bigint value to convert\n * @param places - Number of decimal places (default 18)\n * @returns The whole-number bigint result\n */\nexport const fromFixedPoint = (value: bigint, places = 18): bigint => {\n  if (!Number.isInteger(places)) throw new Error(`places (${places}) must be an Integer`)\n  return value / (10n ** BigInt(places))\n}\n","/**\n * Formats a number to the specified number of significant digits, returning a string with minimal trailing zeros.\n * @param value - The number to format\n * @param digits - The number of significant digits\n * @returns A string representation of the number with the specified precision\n */\nexport const toDecimalPrecision = (value: number, digits: number) => {\n  let fixed = 0\n  const result = Number.parseFloat(value.toPrecision(digits))\n  while (Number.parseFloat(result.toFixed(fixed)) !== result && fixed < 20) {\n    fixed++\n  }\n  return result.toFixed(fixed)\n}\n","/**\n * Converts a bigint or decimal string to a fixed-point bigint representation.\n * @param value - The value to convert (bigint or string with optional decimal point)\n * @param places - Number of decimal places (default 18)\n * @returns A bigint representing the value scaled by 10^places\n */\nexport const toFixedPoint = (value: bigint | string, places = 18): bigint => {\n  if (!Number.isInteger(places)) throw new Error(`places (${places}) must be an Integer`)\n  if (typeof value === 'string') {\n    const parts = value.split('.')\n    if (parts.length > 2) {\n      throw new Error('Too many decimals in value')\n    }\n    if (parts.length === 1) {\n      return BigInt(value) * (10n ** BigInt(places))\n    }\n    const [whole, fraction] = parts\n    const trimmed = fraction.slice(0, places)\n    return BigInt(whole + trimmed.padEnd(Number(places), '0'))\n  }\n  return value * (10n ** BigInt(places))\n}\n"],"mappings":";AAMO,IAAM,iBAAiB,CAAC,OAAe,SAAS,OAAe;AACpE,MAAI,CAAC,OAAO,UAAU,MAAM,EAAG,OAAM,IAAI,MAAM,WAAW,MAAM,sBAAsB;AACtF,SAAO,QAAS,OAAO,OAAO,MAAM;AACtC;;;ACHO,IAAM,qBAAqB,CAAC,OAAe,WAAmB;AACnE,MAAI,QAAQ;AACZ,QAAM,SAAS,OAAO,WAAW,MAAM,YAAY,MAAM,CAAC;AAC1D,SAAO,OAAO,WAAW,OAAO,QAAQ,KAAK,CAAC,MAAM,UAAU,QAAQ,IAAI;AACxE;AAAA,EACF;AACA,SAAO,OAAO,QAAQ,KAAK;AAC7B;;;ACPO,IAAM,eAAe,CAAC,OAAwB,SAAS,OAAe;AAC3E,MAAI,CAAC,OAAO,UAAU,MAAM,EAAG,OAAM,IAAI,MAAM,WAAW,MAAM,sBAAsB;AACtF,MAAI,OAAO,UAAU,UAAU;AAC7B,UAAM,QAAQ,MAAM,MAAM,GAAG;AAC7B,QAAI,MAAM,SAAS,GAAG;AACpB,YAAM,IAAI,MAAM,4BAA4B;AAAA,IAC9C;AACA,QAAI,MAAM,WAAW,GAAG;AACtB,aAAO,OAAO,KAAK,IAAK,OAAO,OAAO,MAAM;AAAA,IAC9C;AACA,UAAM,CAAC,OAAO,QAAQ,IAAI;AAC1B,UAAM,UAAU,SAAS,MAAM,GAAG,MAAM;AACxC,WAAO,OAAO,QAAQ,QAAQ,OAAO,OAAO,MAAM,GAAG,GAAG,CAAC;AAAA,EAC3D;AACA,SAAO,QAAS,OAAO,OAAO,MAAM;AACtC;","names":[]}

package/dist/neutral/toDecimalPrecision.d.ts

@@ -1,2 +1,8 @@
+/**
+ * Formats a number to the specified number of significant digits, returning a string with minimal trailing zeros.
+ * @param value - The number to format
+ * @param digits - The number of significant digits
+ * @returns A string representation of the number with the specified precision
+ */
 export declare const toDecimalPrecision: (value: number, digits: number) => string;
 //# sourceMappingURL=toDecimalPrecision.d.ts.map

package/dist/neutral/toDecimalPrecision.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"toDecimalPrecision.d.ts","sourceRoot":"","sources":["../../src/toDecimalPrecision.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,kBAAkB,GAAI,OAAO,MAAM,EAAE,QAAQ,MAAM,WAO/D,CAAA"}
+{"version":3,"file":"toDecimalPrecision.d.ts","sourceRoot":"","sources":["../../src/toDecimalPrecision.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,GAAI,OAAO,MAAM,EAAE,QAAQ,MAAM,WAO/D,CAAA"}

package/dist/neutral/toFixedPoint.d.ts

@@ -1,2 +1,8 @@
+/**
+ * Converts a bigint or decimal string to a fixed-point bigint representation.
+ * @param value - The value to convert (bigint or string with optional decimal point)
+ * @param places - Number of decimal places (default 18)
+ * @returns A bigint representing the value scaled by 10^places
+ */
 export declare const toFixedPoint: (value: bigint | string, places?: number) => bigint;
 //# sourceMappingURL=toFixedPoint.d.ts.map

package/dist/neutral/toFixedPoint.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"toFixedPoint.d.ts","sourceRoot":"","sources":["../../src/toFixedPoint.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,YAAY,GAAI,OAAO,MAAM,GAAG,MAAM,EAAE,eAAW,KAAG,MAelE,CAAA"}
+{"version":3,"file":"toFixedPoint.d.ts","sourceRoot":"","sources":["../../src/toFixedPoint.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,eAAO,MAAM,YAAY,GAAI,OAAO,MAAM,GAAG,MAAM,EAAE,eAAW,KAAG,MAelE,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/decimal-precision",
-  "version": "5.0.83",
+  "version": "5.0.86",
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "keywords": [
     "decimal",
@@ -43,8 +43,8 @@
     "!**/*.test.*"
   ],
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "~7.4.11",
-    "@xylabs/tsconfig": "~7.4.11",
+    "@xylabs/ts-scripts-yarn3": "~7.4.16",
+    "@xylabs/tsconfig": "~7.4.16",
     "typescript": "~5.9.3",
     "vitest": "~4.0.18"
   },