cytoplasmic
    Preparing search index...

    Interface TranslationProvider

    Translation provider interface. Implement this to provide translations for _ and _n.

    interface TranslationProvider {
        onLanguageChange: Observable<void>;
        translate(msgid: string, parameters: Partial): string;
        translateNumeric(
            msgid: string,
            msgidPlural: string,
            parameters: { n: number } & Partial<Record<string, string | number>>,
        ): string;
    }

    Implemented by

    Index

    Properties

    onLanguageChange: Observable<void>

    When triggered all previously translated strings will be retranslated.

    Methods

    • Translate a string for use with _.

      Parameters

      • msgid: string

        Translation key

      • parameters: Partial

        Translation parameter object

      Returns string

    • Translate a string for use with _n.

      Parameters

      • msgid: string

        Translation key

      • msgidPlural: string

        Translation key, plural

      • parameters: { n: number } & Partial<Record<string, string | number>>

        Translation parameter object

      Returns string