quantible 0.1.0-alpha

package/dist/types/utils/parseSuperscript.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Converts a string of superscript digits to regular integer string.
+ * @param {string} superscriptString - String containing superscript digits.
+ * @returns {string} - String of regular digits.
+ */
+export declare function toRegularInteger(superscriptString: string): string;

package/dist/types/utils/stringBuilding/exponent.d.ts

@@ -0,0 +1,2 @@
+/** * Converts an exponent integer to its spoken word representation, * optionally using "squared" and "cubed" for exponents 2 and 3. * @param exponent The exponent value as an integer. * @param onlyUsePowerOf A boolean flag. If false, uses "squared" for 2 and "cubed" for 3. * If true, uses "to the power of two", "to the power of three", etc. * @returns The spoken word representation of the exponent. */
+export declare function exponentSpokenWord(exponent: string, onlyUsePowerOf?: boolean): string;

package/dist/types/utils/stringBuilding/negative.d.ts

@@ -0,0 +1 @@
+export declare const negative: (bool: boolean) => string;

package/dist/types/utils/stringBuilding/perDigit.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Converts each digit in a number to words, and returns them as a joined string.
+ * @param num The number to convert, as a string.
+ * @returns A string of space-separated words, where each word is a digit in the original number.
+ * @example convertPerDigit("123") => "one two three"
+ */
+export declare function perDigit(num: string): string;

package/dist/types/utils/stringBuilding/positiveInteger.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Converts a non-negative integer into its full English word representation.
+ * @param num The integer to convert.
+ * @returns The word representation of the number, or an error message for invalid input.
+ */
+export declare function positiveInteger(num: number): string;

package/dist/types/utils/stringBuilding/twoDigits.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Converts a given number of cents to words, provided it is a valid number between 0 and 99.
+ * @param num The number of cents to convert, as a string.
+ * @returns The word representation of the number of cents, or an empty string if the conversion failed.
+ */
+export declare function twoDigit(num: string): string;

package/dist/types/utils/stringBuilding/zeroTo999.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Converts a number less than 1000 into words.
+ * @param num The number to convert (0-999).
+ * @returns The word representation of the number.
+ */
+export declare function zeroTo999(num: number): string;

package/dist/types/utils/validateExtractionResultObject.d.ts

@@ -0,0 +1,12 @@
+import { ExtractionResult } from "../interfaces/definitions";
+/**
+ * Validates an ExtractionResult object.
+ *
+ * Checks that the object is present, contains the required properties, and that
+ * the values of those properties are of the correct type.
+ *
+ * If the object is invalid, throws an Error with a description of the problem.
+ *
+ * @param {ExtractionResult} extractionResult - The object to validate.
+ */
+export declare function validateExtractionResult(extractionResult: ExtractionResult): void;

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "quantible",
+  "version": "0.1.0-alpha",
+  "description": "A versatile library for converting numerical values, units, currency, and mathematical expressions into their spoken word equivalents.",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "require": "./dist/cjs/index.js",
+      "import": "./dist/esm/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "!memlog"
+  ],
+  "scripts": {
+    "test": "jest _tests_",
+    "build:cjs": "tsc --project tsconfig.cjs.json",
+    "build:esm": "tsc --project tsconfig.esm.json",
+    "build": "npm run build:cjs && npm run build:esm",
+    "compile": "tsc && node dist/index.js",
+    "lint": "eslint . --ext .ts",
+    "format": "prettier --write ."
+  },
+  "keywords": [
+    "number",
+    "unit",
+    "converter",
+    "natural language",
+    "spoken word",
+    "quantity",
+    "expression",
+    "spoken words",
+    "currency",
+    "math",
+    "text-to-speech",
+    "tts",
+    "numerical values"
+  ],
+  "author": "rinaldowouterson",
+  "license": "ISC",
+  "repository": "https://github.com/rinaldowouterson/quantible",
+  "homepage": "https://github.com/rinaldowouterson/quantible#readme",
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.14",
+    "@typescript-eslint/eslint-plugin": "^8.29.1",
+    "@typescript-eslint/parser": "^8.29.1",
+    "eslint": "^9.24.0",
+    "eslint-config-prettier": "^10.1.2",
+    "eslint-plugin-prettier": "^5.2.6",
+    "jest": "^29.7.0",
+    "prettier": "^3.5.3",
+    "ts-jest": "^29.3.1",
+    "typescript": "^5.8.2"
+  }
+}