@gks101/numtowords - v1.0.3
    Preparing search index...

    Interface ConvertOptions

    Options passed to convert()

    interface ConvertOptions {
        capitalize?: boolean;
        currency?: string | boolean | CurrencyOptions;
        locale?: LocaleInput;
        ordinal?: boolean;
        useAnd?: boolean;
    }
    Index

    Properties

    capitalize? currency? locale? ordinal? useAnd?

    Properties

    capitalize?: boolean

    Capitalise the first letter of the result.

    true
    currency?: string | boolean | CurrencyOptions

    Currency mode.

    • true: use locale currency defaults
    • string: append the provided label (legacy behavior), e.g. "USD"
    • object: full currency rendering configuration
    false
    locale?: LocaleInput

    Target locale / numeral system.

    • "en" — English (International): 1,000,000 = One Million
    • "in" — Indian numbering system: 10,00,000 = Ten Lakh
    • "hi" — Hindi words (Indian system): दस लाख
    • "de" — German
    • "fr" — French
    "en"
    ordinal?: boolean

    Convert integer value to ordinal words (e.g. "first", "twenty-first"). Ordinal mode does not support decimal inputs.

    false
    useAnd?: boolean

    Include "and" connector where applicable (English only).

    true

    Settings

    Member Visibility

    On This Page

    Properties