@technobuddha/library
Version:
A large library of useful functions
17 lines (16 loc) • 1.08 kB
TypeScript
import { type Numbering } from './numbering.ts';
/**
* Converts a numeric input into its alphabetic (word-based) representation according to the specified numbering options.
*
* This function decomposes the input number into its constituent parts and constructs a string representation
* using alphabetic words, optionally handling ordinals, fractions, and different output formats (hybrid, numeric, alphabetic).
* @param input - The numeric value to be converted into an alphabetic string.
* @param options - An object specifying formatting options:
* - `output`: Determines the output style (e.g., 'hybrid', 'alphabetic', 'numeric').
* - `precision`: The number of decimal places to consider.
* - `ordinal`: Whether to output the ordinal form (e.g., "first", "second").
* - `shift`: Specifies the numeric shift (e.g., 'decimal').
* @returns The alphabetic string representation of the input number, formatted according to the provided options.
* @internal
*/
export declare function fabricateAlphabeticInteger(input: number, options: Numbering): string;