Skip to main content

nestjs-i18n

Classes​

Interfaces​

Type Aliases​

Formatter​

Ƭ Formatter: (template: string, ...args: (string | Record<string, string>)[]) => string

Type declaration​

▸ (template, ...args): string

Parameters​
NameType
templatestring
...args(string | Record<string, string>)[]
Returns​

string

Defined in​

src/interfaces/i18n-options.interface.ts:38

I18nOptionResolver​

Ƭ I18nOptionResolver: ResolverWithOptions | Type<I18nResolver> | I18nResolver

Defined in​

src/interfaces/i18n-options.interface.ts:33

I18nOptionsWithoutResolvers​

Ƭ I18nOptionsWithoutResolvers: Omit<I18nOptions, "resolvers" | "loader">

Defined in​

src/interfaces/i18n-options.interface.ts:28

I18nValidationError​

Ƭ I18nValidationError: ValidationError

Defined in​

src/interfaces/i18n-validation-error.interface.ts:3

I18nValidationPipeOptions​

Ƭ I18nValidationPipeOptions: Omit<ValidationPipeOptions, "exceptionFactory">

Defined in​

src/pipes/i18n-validation.pipe.ts:9

I18nValidatorOptions​

Ƭ I18nValidatorOptions: ValidatorOptions

Defined in​

src/interfaces/i18n-options.interface.ts:78

OptionProvider​

Ƭ OptionProvider<T>: Omit<ClassProvider<T>, "provide"> | Omit<ValueProvider<T>, "provide"> | Omit<FactoryProvider<T>, "provide"> | Omit<ExistingProvider<T>, "provide"> | OptionsProvider

Type parameters​

NameType
Tany

Defined in​

src/interfaces/i18n-options.interface.ts:17

Path​

Ƭ Path<T>: keyof T extends string ? PathImpl2<T> extends infer P ? P extends string | keyof T ? P : keyof T : keyof T : never

Type parameters​

Name
T

Defined in​

src/types.ts:27

PathValue​

Ƭ PathValue<T, P>: P extends `${infer Key}.${infer Rest}` ? Key extends keyof T ? Rest extends Path<T[Key]> ? PathValue<T[Key], Rest> : never : never : P extends keyof T ? T[P] : never

Type parameters​

NameType
TT
Pextends Path<T>

Defined in​

src/types.ts:35

ResolverWithOptions​

Ƭ ResolverWithOptions: { use: Type<I18nResolver> } & OptionProvider

Defined in​

src/interfaces/i18n-options.interface.ts:24

TranslateOptions​

Ƭ TranslateOptions: Object

Type declaration​

NameType
args?({ [k: string]: any; } | string)[] | { [k: string]: any; }
debug?boolean
defaultValue?string
lang?string

Defined in​

src/services/i18n.service.ts:27

Variables​

I18N_LANGUAGES​

• Const I18N_LANGUAGES: "I18nLanguages"

Defined in​

src/i18n.constants.ts:3

I18N_LOADER_OPTIONS​

• Const I18N_LOADER_OPTIONS: "I18nLoaderOptions"

Defined in​

src/i18n.constants.ts:6

I18N_OPTIONS​

• Const I18N_OPTIONS: "I18nOptions"

Defined in​

src/i18n.constants.ts:1

I18N_RESOLVERS​

• Const I18N_RESOLVERS: "I18nResolvers"

Defined in​

src/i18n.constants.ts:5

I18N_RESOLVER_OPTIONS​

• Const I18N_RESOLVER_OPTIONS: "I18nResolverOptions"

Defined in​

src/i18n.constants.ts:4

I18N_TRANSLATIONS​

• Const I18N_TRANSLATIONS: "I18nTranslations"

Defined in​

src/i18n.constants.ts:2

logger​

• Const logger: Logger

Defined in​

src/i18n.module.ts:52

Functions​

I18n​

▸ I18n(...dataOrPipes): ParameterDecorator

Defines HTTP route param decorator

Parameters​

NameType
...dataOrPipesany[]

Returns​

ParameterDecorator

Public Api

Defined in​

node_modules/@nestjs/common/decorators/http/create-route-param-metadata.decorator.d.ts:12

I18nLang​

▸ I18nLang(...dataOrPipes): ParameterDecorator

Defines HTTP route param decorator

Parameters​

NameType
...dataOrPipesany[]

Returns​

ParameterDecorator

Public Api

Defined in​

node_modules/@nestjs/common/decorators/http/create-route-param-metadata.decorator.d.ts:12

I18nLanguages​

▸ I18nLanguages(): (target: object, key: string | symbol, index?: number) => void

Returns​

fn

▸ (target, key, index?): void

Decorator that marks a constructor parameter as a target for Dependency Injection (DI).

Any injected provider must be visible within the module scope (loosely speaking, the containing module) of the class it is being injected into. This can be done by:

  • defining the provider in the same module scope
  • exporting the provider from one module scope and importing that module into the module scope of the class being injected into
  • exporting the provider from a module that is marked as global using the @Global() decorator

Injection tokens​

Can be types (class names), strings or symbols. This depends on how the provider with which it is associated was defined. Providers defined with the @Injectable() decorator use the class name. Custom Providers may use strings or symbols as the injection token.

Parameters​
NameType
targetobject
keystring | symbol
index?number
Returns​

void

See

Public Api

Defined in​

src/decorators/i18n-languages.decorator.ts:4

I18nResolverOptions​

▸ I18nResolverOptions(): any

Returns​

any

Defined in​

src/decorators/i18n-resolver-options.decorator.ts:8

getContextObject​

▸ getContextObject(context?): any

Parameters​

NameType
context?ExecutionContext | ArgumentsHost

Returns​

any

Defined in​

src/utils/context.ts:5

getI18nResolverOptionsToken​

▸ getI18nResolverOptionsToken(target): string

Parameters​

NameType
target() => void

Returns​

string

Defined in​

src/decorators/i18n-resolver-options.decorator.ts:4

i18nValidationErrorFactory​

▸ i18nValidationErrorFactory(errors): I18nValidationException

Parameters​

NameType
errorsValidationError[]

Returns​

I18nValidationException

Defined in​

src/utils/util.ts:35

i18nValidationMessage​

▸ i18nValidationMessage<K>(key, args?): (a: ValidationArguments) => string

Type parameters​

NameType
KRecord<string, unknown>

Parameters​

NameType
keyPath<K>
args?any

Returns​

fn

▸ (a): string

Parameters​
NameType
aValidationArguments
Returns​

string

Defined in​

src/utils/util.ts:45