Aller au contenu principal

i18n.ts

Source : sdks/typescript/packages/sdk/src/i18n.ts. Retour à l'index de la référence du SDK TypeScript.

remarque

Cette page est générée par tools/docs/gen_sdk_reference.py depuis les sources du SDK et les dossiers de textes OpenAPI. Ne la modifiez pas à la main : changez la source et régénérez.

Alias de type Locale​

Langue des messages du SDK : en ou fr.

Définition : "en" \| "fr".

Fonctions​

t​

t(key: string, locale: Locale = "en", params: Record<string, unknown> = {}): string

Traduit une clé de message et remplit ses emplacements {name}.

NomTypeDéfautRequisDescription
keystringouiClé du message, par exemple timeout ; une clé inconnue est renvoyée telle quelle.
localeLocale"en"nonLangue, en par défaut ; une clé absente en fr se replie sur en.
paramsRecord<string, unknown>{}nonChamps supplémentaires fusionnés dans la requête.

Retour : string. Le message avec les paramètres connus remplis.

messages​

messages(locale: Locale): Readonly<Record<string, string>>

Donne le catalogue de messages d'une langue.

NomTypeDéfautRequisDescription
localeLocaleouien ou fr.

Retour : Readonly<Record<string, string>>. Table en lecture seule des clés de message vers leurs gabarits.