quantible 0.1.3-alpha → 0.1.5-alpha

package/dist/index.d.mts

@@ -0,0 +1,107 @@
+/**
+ * @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 };

package/dist/index.d.ts

@@ -0,0 +1,107 @@
+/**
+ * @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 };