@japofc/baileys - v2.4.7
    Preparing search index...

    Interface I18n

    interface I18n {
        addLanguage(lang: string, dict: Record<string, unknown>): I18n;
        addLanguages(dicts: Record<string, Record<string, unknown>>): I18n;
        formatDate(
            value: number | Date,
            chatOrLang?: string,
            options?: DateTimeFormatOptions,
        ): string;
        formatNumber(
            value: number,
            chatOrLang?: string,
            options?: NumberFormatOptions,
        ): string;
        getChatLang(chat: string): string;
        getLanguages(): string[];
        getMissingKeys(lang: string): string[];
        has(key: string, lang?: string): boolean;
        hasLanguage(lang: string): boolean;
        load(snapshot: Record<string, unknown>): void;
        removeLanguage(lang: string): boolean;
        resetChatLang(chat: string): boolean;
        setChatLang(chat: string, lang: string): void;
        t(key: string, vars?: Record<string, unknown>, lang?: string): string;
        tFor(chat: string, key: string, vars?: Record<string, unknown>): string;
        tn(
            key: string,
            count: number,
            vars?: Record<string, unknown>,
            lang?: string,
        ): string;
        tnFor(
            chat: string,
            key: string,
            count: number,
            vars?: Record<string, unknown>,
        ): string;
        toJSON(): Record<string, unknown>;
    }
    Index
    addLanguage addLanguages formatDate formatNumber getChatLang getLanguages getMissingKeys has hasLanguage load removeLanguage resetChatLang setChatLang t tFor tn tnFor toJSON

    • Register/merge a dictionary (nested objects become dot-paths).

      Parameters

      • lang: string
      • dict: Record<string, unknown>

      Returns I18n

    • Register many dictionaries at once.

      Parameters

      • dicts: Record<string, Record<string, unknown>>

      Returns I18n

    • Locale-aware date formatting (pass a chat jid or a lang code).

      Parameters

      • value: number | Date
      • OptionalchatOrLang: string
      • Optionaloptions: DateTimeFormatOptions

      Returns string

    • Locale-aware number formatting (pass a chat jid or a lang code).

      Parameters

      • value: number
      • OptionalchatOrLang: string
      • Optionaloptions: NumberFormatOptions

      Returns string

    • Keys the default language has that lang is missing.

      Parameters

      • lang: string

      Returns string[]

    • Does a translation exist (no fallback-to-key)?

      Parameters

      • key: string
      • Optionallang: string

      Returns boolean

    • Parameters

      • snapshot: Record<string, unknown>

      Returns void

    • Parameters

      • lang: string

      Returns boolean

    • Parameters

      • chat: string

      Returns boolean

    • Parameters

      • chat: string
      • lang: string

      Returns void

    • Parameters

      • key: string
      • Optionalvars: Record<string, unknown>
      • Optionallang: string

      Returns string

    • Translate in a chat's configured language.

      Parameters

      • chat: string
      • key: string
      • Optionalvars: Record<string, unknown>

      Returns string

    • Plural-aware: key.one for count 1, else key.other ({count} available).

      Parameters

      • key: string
      • count: number
      • Optionalvars: Record<string, unknown>
      • Optionallang: string

      Returns string

    • Parameters

      • chat: string
      • key: string
      • count: number
      • Optionalvars: Record<string, unknown>

      Returns string

    Settings
    Member Visibility

    On This Page
    Methods