Interface FormatQuantityOptions

interface FormatQuantityOptions {
    fractionSlash?: boolean;
    romanNumerals?: boolean;
    tolerance?: number;
    vulgarFractions?: boolean;
}

Properties

fractionSlash?: boolean

Output the fraction slash character (⁄) instead of the "solidus" slash (/) for fractions. Results appear like "1⁄2" instead of "1/2". Overridden by the vulgarFractions option.

romanNumerals?: boolean

Output in Roman numerals. Provided value must be between 1 and 3999, inclusive. Decimal values will be ignored (Math.floor is used to remove them). Overrides all other options.

tolerance?: number

Amount by which a number can deviate from the calculated quotient to be considered a match. For example, 0.66 is close enough to 2 ÷ 3 (which is 0.66666... repeating) to be considered equivalent so the function will return "2/3". The smaller this number, the higher the likelihood that the function will return a decimal instead of a fraction or mixed number.

Default

0.0075
vulgarFractions?: boolean

Output vulgar fractions, like "½" instead of "1/2", when appropriate. Overrides the fractionSlash option.

Generated using TypeDoc