Skip to content

GramIO API Reference / @gramio/i18n/dist

@gramio/i18n/dist

Interfaces

InterfaceDescription
I18nOptions-
LanguageMap-

Type Aliases

Type AliasDescription
ExtractArgsParams-
ExtractItemValue-
ExtractLanguages-
GetI18nKeys-
GetI18nParams-
GetValueNested-
LanguagesMap-
LocaleArgs-
LocaleItem-
LocaleValue-
NestedKeysDelimited-
ShouldFollowLanguage-
ShouldFollowLanguageStrict-
SoftString-

Functions

defineI18n()

defineI18n<Languages, PrimaryLanguage>(__namedParameters): object

Defined in: i18n/index.d.ts:41

Type Parameters

Type Parameter
Languages extends LanguagesMap
PrimaryLanguage extends string | number | symbol

Parameters

ParameterType
__namedParametersI18nOptions<Languages, PrimaryLanguage>

Returns

NameTypeDescriptionDefined in
_object-i18n/index.d.ts:61
_.languagesLanguages-i18n/index.d.ts:62
_.primaryLanguagePrimaryLanguage-i18n/index.d.ts:63
buildT()<Language>(language?) => <Key, Item, FallbackItem>(key, ...args) => ExtractItemValue<Item, FallbackItem>-i18n/index.d.ts:45
languageskeyof Languages[]-i18n/index.d.ts:43
primaryLanguagePrimaryLanguage-i18n/index.d.ts:44
t()<Language, Key, Item, FallbackItem>(language, key, ...args) => ExtractItemValue<Item, FallbackItem>-i18n/index.d.ts:42
localesFor()(key, ...args) => Record<string, string>Generate a { languageCode: description } record for all non-primary languages. Designed for use with CommandMeta.locales in syncCommands(). Only includes languages where the key resolves to a plain string (no args). Example bot.command("help", { description: i18n.t("en", "cmd.help"), locales: i18n.localesFor("cmd.help"), }, (ctx) => ctx.send("Help"));i18n/index.d.ts:60

pluralizeEnglish()

pluralizeEnglish<T>(n, one, many): T

Defined in: i18n/index.d.ts:37

Type Parameters

Type Parameter
T

Parameters

ParameterType
nnumber
oneT
manyT

Returns

T


pluralizeRussian()

pluralizeRussian<T>(count, one, few, many): T

Defined in: i18n/index.d.ts:39

Type Parameters

Type Parameter
T

Parameters

ParameterType
countnumber
oneT
fewT
manyT

Returns

T