Interface UseAbbreviateNumberParams

Parameters for useAbbreviateNumber hook.

interface UseAbbreviateNumberParams {
    case?: "lower" | "upper";
    input: string | number;
    rounding?: "none" | "up" | "down";
}

Hierarchy

  • AbbreviateOptions
    • UseAbbreviateNumberParams

Properties

Properties

case?: "lower" | "upper"

The case for the suffix. 'lower' for lowercase, 'upper' for uppercase. Default is 'upper'.

input: string | number

The input number or a string representing a number.

rounding?: "none" | "up" | "down"

The rounding method to be applied. 'up' for rounding up, 'down' for rounding down, 'none' for no rounding. Default is 'none'.