quantible 0.1.5-alpha → 0.1.6-alpha

package/dist/types/converters/convertUnitOnlyToSpokenWord.d.ts

@@ -0,0 +1,8 @@
+import { baseUnitOnly } from "../interfaces/definitions.js";
+/**
+ * Converts a unit-only object into its spoken word representation.
+ * @param {baseUnitOnly} unitOnlyObject - The unit-only object to convert.
+ * @returns {string} The spoken word representation of the unit.
+ */
+export declare function convertUnitOnlyToSpokenWord(unitOnlyObject: baseUnitOnly): string;
+//# sourceMappingURL=convertUnitOnlyToSpokenWord.d.ts.map

package/dist/types/converters/convertUnitOnlyToSpokenWord.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"convertUnitOnlyToSpokenWord.d.ts","sourceRoot":"","sources":["../../../src/converters/convertUnitOnlyToSpokenWord.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAE5D;;;;GAIG;AACH,wBAAgB,2BAA2B,CAAC,cAAc,EAAE,YAAY,GAAG,MAAM,CAkBhF"}

package/dist/{index.d.ts → types/index.d.ts}

@@ -1,54 +1,6 @@
-/**
- * @interface ExtractionResult
- * @description Represents all possible extraction results
- * and contains all properties that can be extracted from a given input string.
- */
-interface ExtractionResult {
-    input: string;
-    matchType: string;
-    index: number;
-    integer?: string;
-    decimal?: string;
-    negativeInt?: boolean;
-    currency?: string;
-    exponent?: string;
-    unit?: string;
-    unitExponent?: string;
-}
-
-/**
- * Returns the first match of a number, currency, unit, or exponent in the given string.
- * The returned object contains the extracted groups and additional information such as
- * the type of match and the index of the match in the string.
- *
- * @param {string} input - The string to search for matches
- * @returns {patternExtraction | null} - The extracted groups and additional information, or null if no match is found
- */
-declare function extractFirstMatch(input: string): ExtractionResult | null;
-/**
- * Extracts all matches of a number, currency, unit, or exponent in the given string
- * and returns an array of the extracted groups and additional information such as
- * the type of match and the index of the match in the string.
- *
- * If the input string contains no matches, an empty array is returned.
- *
- * @param {string} input - The string to search for matches
- * @returns {patternExtraction[]} - The extracted groups and additional information, or an empty array if no match is found
- */
-declare function extractAllMatches(input: string): ExtractionResult[];
-
-/**
- * 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.
- */
-declare function validateExtractionResult(extractionResult: ExtractionResult): void;
-
+import { extractFirstMatch, extractAllMatches } from "./utils/extraction/patternExtractor.js";
+import { ExtractionResult } from "./interfaces/definitions.js";
+import { validateExtractionResult } from "./utils/validateExtractionResultObject.js";
 /**
  * @namespace extractQuantities
  * @description Contains functions for extracting numeric data from a string.
@@ -103,5 +55,5 @@ declare const convertQuantities: {
      */
     autoReplaceAllMatches: (input: string) => string;
 };
-
 export { convertQuantities, extractQuantities, validateExtractionResult };
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,wCAAwC,CAAC;AAQ9F,OAAO,EAOL,gBAAgB,EACjB,MAAM,6BAA6B,CAAC;AAErC,OAAO,EAAE,wBAAwB,EAAE,MAAM,2CAA2C,CAAC;AAErF;;;GAGG;AACH,QAAA,MAAM,iBAAiB;IACrB;;;;OAIG;;IAEH;;;;OAIG;;CAEJ,CAAC;AAEF;;;GAGG;AACH,QAAA,MAAM,iBAAiB;IACrB;;;;;OAKG;IACH;;;;;OAKG;uCACgC,gBAAgB,KAAG,MAAM;IAiC5D;;;;;;;OAOG;mCAC4B,MAAM,KAAG,MAAM;IAM9C;;;;;;OAMG;mCAC4B,MAAM,KAAG,MAAM;CAmB/C,CAAC;AAEF,OAAO,EAAE,iBAAiB,EAAG,iBAAiB,EAAE,wBAAwB,EAAE,CAAA"}

package/dist/types/interfaces/configurations/default.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Configuration for currency fraction (e.g., cents).
+ */
+export interface CurrencyFractionConfig {
+    singular: string;
+    plural: string;
+}
+/**
+ * Configuration for currency (e.g., USD).
+ */
+export interface Currency {
+    singular: string;
+    plural: string;
+    fraction: CurrencyFractionConfig | null;
+}
+/**
+ * Configuration for a unit (e.g., meter).
+ */
+export interface Unit {
+    singular: string;
+    plural: string;
+}
+//# sourceMappingURL=default.d.ts.map

package/dist/types/interfaces/configurations/default.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"default.d.ts","sourceRoot":"","sources":["../../../../src/interfaces/configurations/default.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,sBAAsB,GAAG,IAAI,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,WAAW,IAAI;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;CAChB"}

package/dist/types/interfaces/definitions.d.ts

@@ -0,0 +1,101 @@
+/**
+ * Represents the base structure for all extraction results,
+ * containing the input string, match type, index, and length of the extracted value.
+ */
+interface baseExtraction {
+    input: string;
+    matchType: string;
+    index: number;
+}
+/**
+ * @interface numericBaseExtraction
+ * @extends {baseExtraction}
+ * @description Represents the base structure for numeric extraction results,
+ * extending the baseExtraction with properties for integer, decimal, and negative integer indication.
+ */
+interface numericBaseExtraction extends baseExtraction {
+    integer: string;
+    decimal?: string;
+    negativeInt: boolean;
+}
+/**
+ * @interface baseCurrency
+ * @extends {numericBaseExtraction}
+ * @description Represents the structure for currency extraction results,
+ * extending the numericBaseExtraction with properties for match type (symbol or code) and currency symbol or code.
+ */
+export interface baseCurrency extends numericBaseExtraction {
+    matchType: "symbolCurrency" | "codeCurrency";
+    currency: string;
+}
+/**
+ * @interface baseScientific
+ * @extends {numericBaseExtraction}
+ * @description Represents the structure for scientific notation extraction results,
+ * extending the numericBaseExtraction with properties for match type (scientific) and a mandatory exponent value.
+ */
+export interface baseScientific extends numericBaseExtraction {
+    matchType: "scientific";
+    exponent: string;
+}
+/**
+ * @interface baseNumberUnit
+ * @extends {numericBaseExtraction}
+ * @description Represents the structure for quantitative unit extraction results,
+ * extending the numericBaseExtraction with properties for match type (unit), unit name, optional exponent, and optional unit exponent.
+ */
+export interface baseNumberUnit extends numericBaseExtraction {
+    matchType: "unit";
+    unit: string;
+    exponent?: string;
+    unitExponent?: string;
+}
+/**
+ * @interface baseUnitOnly
+ * @extends {baseExtraction}
+ * @description Represents the structure for unit-only extraction results,
+ * extending the baseExtraction with properties for match type (unitOnly), unit name, and optional unit exponent.
+ */
+export interface baseUnitOnly extends baseExtraction {
+    matchType: "unitOnly";
+    unit: string;
+    unitExponent?: string;
+}
+/**
+ * @interface baseOperator
+ * @extends {baseExtraction}
+ * @description Represents the structure for mathematical operator extraction results,
+ * extending the baseExtraction with a property for match type (operator).
+ */
+export interface baseOperator extends baseExtraction {
+    matchType: "operator";
+}
+/**
+ * @interface baseNumber
+ * @extends {numericBaseExtraction}
+ * @description Represents the structure for number extraction results,
+ * extending the numericBaseExtraction with properties for match type (number) and an optional exponent.
+ */
+export interface baseNumber extends numericBaseExtraction {
+    matchType: "number";
+    exponent?: string;
+}
+/**
+ * @interface ExtractionResult
+ * @description Represents all possible extraction results
+ * and contains all properties that can be extracted from a given input string.
+ */
+export interface ExtractionResult {
+    input: string;
+    matchType: string;
+    index: number;
+    integer?: string;
+    decimal?: string;
+    negativeInt?: boolean;
+    currency?: string;
+    exponent?: string;
+    unit?: string;
+    unitExponent?: string;
+}
+export {};
+//# sourceMappingURL=definitions.d.ts.map

package/dist/types/interfaces/definitions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"definitions.d.ts","sourceRoot":"","sources":["../../../src/interfaces/definitions.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,UAAU,cAAc;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;GAKG;AACH,UAAU,qBAAsB,SAAQ,cAAc;IACpD,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,OAAO,CAAC;CACtB;AAED;;;;;GAKG;AACH,MAAM,WAAW,YAAa,SAAQ,qBAAqB;IACzD,SAAS,EAAE,gBAAgB,GAAG,cAAc,CAAC;IAC7C,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;;GAKG;AACH,MAAM,WAAW,cAAe,SAAQ,qBAAqB;IAC3D,SAAS,EAAE,YAAY,CAAC;IACxB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;;GAKG;AACH,MAAM,WAAW,cAAe,SAAQ,qBAAqB;IAC3D,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;;;GAKG;AACH,MAAM,WAAW,YAAa,SAAQ,cAAc;IAClD,SAAS,EAAE,UAAU,CAAC;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;;;GAKG;AACH,MAAM,WAAW,YAAa,SAAQ,cAAc;IAClD,SAAS,EAAE,UAAU,CAAC;CACvB;AAED;;;;;GAKG;AACH,MAAM,WAAW,UAAW,SAAQ,qBAAqB;IACvD,SAAS,EAAE,QAAQ,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB"}

package/dist/types/utils/extraction/patternExtractor.d.ts

@@ -0,0 +1,22 @@
+import { ExtractionResult } from "../../interfaces/definitions.js";
+/**
+ * Returns the first match of a number, currency, unit, or exponent in the given string.
+ * The returned object contains the extracted groups and additional information such as
+ * the type of match and the index of the match in the string.
+ *
+ * @param {string} input - The string to search for matches
+ * @returns {patternExtraction | null} - The extracted groups and additional information, or null if no match is found
+ */
+export declare function extractFirstMatch(input: string): ExtractionResult | null;
+/**
+ * Extracts all matches of a number, currency, unit, or exponent in the given string
+ * and returns an array of the extracted groups and additional information such as
+ * the type of match and the index of the match in the string.
+ *
+ * If the input string contains no matches, an empty array is returned.
+ *
+ * @param {string} input - The string to search for matches
+ * @returns {patternExtraction[]} - The extracted groups and additional information, or an empty array if no match is found
+ */
+export declare function extractAllMatches(input: string): ExtractionResult[];
+//# sourceMappingURL=patternExtractor.d.ts.map

package/dist/types/utils/extraction/patternExtractor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"patternExtractor.d.ts","sourceRoot":"","sources":["../../../../src/utils/extraction/patternExtractor.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAEnE;;;;;;;GAOG;AAEH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,gBAAgB,GAAG,IAAI,CA+DxE;AAED;;;;;;;;;GASG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,gBAAgB,EAAE,CAsBnE"}

package/dist/types/utils/extraction/regexPatterns.d.ts

@@ -0,0 +1,3 @@
+declare const regexMatches: RegExp;
+export { regexMatches };
+//# sourceMappingURL=regexPatterns.d.ts.map

package/dist/types/utils/extraction/regexPatterns.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"regexPatterns.d.ts","sourceRoot":"","sources":["../../../../src/utils/extraction/regexPatterns.ts"],"names":[],"mappings":"AA0BA,QAAA,MAAM,YAAY,QAkDjB,CAAC;AAEF,OAAO,EAAE,YAAY,EAAE,CAAC"}

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

@@ -0,0 +1,7 @@
+/**
+ * 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;
+//# sourceMappingURL=parseSuperscript.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"parseSuperscript.d.ts","sourceRoot":"","sources":["../../../src/utils/parseSuperscript.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,iBAAiB,EAAE,MAAM,GAAG,MAAM,CAwBlE"}

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

@@ -0,0 +1,3 @@
+/** * 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;
+//# sourceMappingURL=exponent.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"exponent.d.ts","sourceRoot":"","sources":["../../../../src/utils/stringBuilding/exponent.ts"],"names":[],"mappings":"AAGA,sZAAsZ;AAEtZ,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,MAAM,EAAE,cAAc,GAAE,OAAe,GAAG,MAAM,CAa5F"}

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

@@ -0,0 +1,2 @@
+export declare const negative: (bool: boolean) => string;
+//# sourceMappingURL=negative.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"negative.d.ts","sourceRoot":"","sources":["../../../../src/utils/stringBuilding/negative.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,QAAQ,GAAI,MAAM,OAAO,KAAG,MAExC,CAAC"}

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

@@ -0,0 +1,8 @@
+/**
+ * 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;
+//# sourceMappingURL=perDigit.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"perDigit.d.ts","sourceRoot":"","sources":["../../../../src/utils/stringBuilding/perDigit.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AAEH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAM5C"}

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

@@ -0,0 +1,7 @@
+/**
+ * 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;
+//# sourceMappingURL=positiveInteger.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"positiveInteger.d.ts","sourceRoot":"","sources":["../../../../src/utils/stringBuilding/positiveInteger.ts"],"names":[],"mappings":"AAGA;;;;GAIG;AAEH,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAuBnD"}

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

@@ -0,0 +1,7 @@
+/**
+ * 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;
+//# sourceMappingURL=twoDigits.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"twoDigits.d.ts","sourceRoot":"","sources":["../../../../src/utils/stringBuilding/twoDigits.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AAEH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAM5C"}

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

@@ -0,0 +1,7 @@
+/**
+ * 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;
+//# sourceMappingURL=zeroTo999.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"zeroTo999.d.ts","sourceRoot":"","sources":["../../../../src/utils/stringBuilding/zeroTo999.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AAEH,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CA4B7C"}

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

@@ -0,0 +1,13 @@
+import { ExtractionResult } from "../interfaces/definitions.js";
+/**
+ * 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;
+//# sourceMappingURL=validateExtractionResultObject.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"validateExtractionResultObject.d.ts","sourceRoot":"","sources":["../../../src/utils/validateExtractionResultObject.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAehE;;;;;;;;;GASG;AACH,wBAAgB,wBAAwB,CAAC,gBAAgB,EAAE,gBAAgB,GAAG,IAAI,CA8LjF"}

package/package.json

@@ -1,27 +1,32 @@
 {
   "name": "quantible",
-  "version": "0.1.5-alpha",
   "description": "A versatile library for extracting and converting numerical values, units, currency, and mathematical expressions into their spoken word equivalents.",
-  "main": "dist/cjs/index.js",
-  "module": "dist/esm/index.js",
+  "version": "0.1.6-alpha",
+  "type": "module",
+  "main": "dist/index.cjs.js",
+  "module": "dist/index.esm.js",
+  "browser": "dist/index.iife.js",
   "types": "dist/types/index.d.ts",
   "exports": {
     ".": {
       "types": "./dist/types/index.d.ts",
-      "import": "./dist/esm/index.js",
-      "require": "./dist/cjs/index.js",
-      "default": "./dist/esm/index.js"
+      "browser": "./dist/index.iife.js",
+      "import": "./dist/index.esm.js",
+      "require": "./dist/index.cjs.js",
+      "default": "./dist/index.esm.js"
     }
   },
   "files": [
-    "dist",
-    "!memlog"
+    "dist"
   ],
+  "sideEffects": false,
   "scripts": {
+    "prebuild": "rm -rf dist",
+    "build:dts": "npx tsc --emitDeclarationOnly",
+    "build:js": "npx tsup",
+    "build": "npm run prebuild && npm run build:js && npm run build:dts",
     "test": "jest _tests_",
-    "build": "tsup",
-    "dev": "tsup --watch",
-    "compile": "tsc && node dist/index.js",
+    "compile": "npm run build && node dist/index.js",
     "lint": "eslint . --ext .ts",
     "format": "prettier --write ."
   },
@@ -57,7 +62,6 @@
     "jest": "^29.7.0",
     "prettier": "^3.5.3",
     "ts-jest": "^29.3.1",
-    "tsup": "^8.4.0",
     "typescript": "^5.8.2"
   }
 }

package/dist/index.d.mts

@@ -1,107 +0,0 @@
-/**
- * @interface ExtractionResult
- * @description Represents all possible extraction results
- * and contains all properties that can be extracted from a given input string.
- */
-interface ExtractionResult {
-    input: string;
-    matchType: string;
-    index: number;
-    integer?: string;
-    decimal?: string;
-    negativeInt?: boolean;
-    currency?: string;
-    exponent?: string;
-    unit?: string;
-    unitExponent?: string;
-}
-
-/**
- * Returns the first match of a number, currency, unit, or exponent in the given string.
- * The returned object contains the extracted groups and additional information such as
- * the type of match and the index of the match in the string.
- *
- * @param {string} input - The string to search for matches
- * @returns {patternExtraction | null} - The extracted groups and additional information, or null if no match is found
- */
-declare function extractFirstMatch(input: string): ExtractionResult | null;
-/**
- * Extracts all matches of a number, currency, unit, or exponent in the given string
- * and returns an array of the extracted groups and additional information such as
- * the type of match and the index of the match in the string.
- *
- * If the input string contains no matches, an empty array is returned.
- *
- * @param {string} input - The string to search for matches
- * @returns {patternExtraction[]} - The extracted groups and additional information, or an empty array if no match is found
- */
-declare function extractAllMatches(input: string): ExtractionResult[];
-
-/**
- * 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.
- */
-declare function validateExtractionResult(extractionResult: ExtractionResult): void;
-
-/**
- * @namespace extractQuantities
- * @description Contains functions for extracting numeric data from a string.
- */
-declare const extractQuantities: {
-    /**
-     * Extracts the first match (number || currency || unit || operator || scientific expression) from the input string.
-     * @param {string} input - The string to extract from.
-     * @returns {ExtractionResult | null} The extracted data or null if no match is found.
-     */
-    firstMatch: typeof extractFirstMatch;
-    /**
-     * Extracts all matches (number || currency || unit || operator || scientific expression) from the input string.
-     * @param {string} input - The string to extract from.
-     * @returns {ExtractionResult[]} The extracted data.
-     */
-    allMatches: typeof extractAllMatches;
-};
-/**
- * @namespace convertQuantities
- * @description Contains functions for converting (number || currency || unit || operator || scientific expression) data from a string or object to spoken word.
- */
-declare const convertQuantities: {
-    /**
-     * Translates an ExtractionResult object (number || currency || unit || operator || scientific expression) into its spoken word equivalent.
-     *
-     * @param {ExtractionResult} extractionResult - The ExtractionResult object to translate.
-     * @returns {string} The spoken word equivalent of the ExtractionResult.
-     */
-    /**
-     * Translates an ExtractionResult object (number || currency || unit || operator || scientific expression) into its spoken word equivalent.
-     *
-     * @param {ExtractionResult} extractionResult - The ExtractionResult object to translate.
-     * @returns {string} The spoken word equivalent of the ExtractionResult.
-     */
-    translateMatch: (extractionResult: ExtractionResult) => string;
-    /**
-     * Extracts the first match (number || currency || unit || operator || scientific expression) from the input string
-     * and translates it to its spoken word equivalent.
-     *
-     * @param {string} input - The string to extract and translate from.
-     * @returns {string} The input string with the first match replaced by its spoken word equivalent,
-     * or an empty string if no match is found.
-     */
-    autoReplaceFirstMatch: (input: string) => string;
-    /**
-     * Extracts all matches (number || currency || unit || operator || scientific expression) from the input string
-     * and translates them to their spoken word equivalents.
-     *
-     * @param {string} input - The string to extract and translate from.
-     * @returns {string} The input string with all matches replaced by their spoken word equivalents. Returns the original string if no matches are found.
-     */
-    autoReplaceAllMatches: (input: string) => string;
-};
-
-export { convertQuantities, extractQuantities, validateExtractionResult };