@technobuddha/library
Version: 
A large library of useful functions
21 lines (20 loc) • 926 B
TypeScript
import { type DeconstructedNumber } from './@types/deconstructed-number.ts';
import { deriveFraction } from './derive-fraction.ts';
import { type Numbering } from './numbering.ts';
/**
 * Options for fabricating a numeric fraction.
 *
 * This type combines the 'ordinal' property from the `Numbering` type
 * and the options accepted by the second parameter of the `deriveFraction` function.
 * @internal
 */
type FNFOptions = Pick<Numbering, 'ordinal'> & Parameters<typeof deriveFraction>[1];
/**
 * Converts a numeric input into a fractional string representation.
 * @param input - The numeric value to be converted into a fraction.
 * @param options - Configuration options for fraction formatting.
 * @returns The formatted fractional string, or `null` if the numerator is zero.
 * @internal
 */
export declare function fabricateNumericFraction(input: DeconstructedNumber, options: FNFOptions): string | null;
export {};