nestjs-i18n/dist/interfaces/i18n-options.interface.d.ts

The i18n module for Nest.

import { Type } from '@nestjs/common';
import { ClassProvider, ExistingProvider, FactoryProvider, ModuleMetadata, ValueProvider } from '@nestjs/common/interfaces';
import { I18nResolver } from './i18n-language-resolver.interface';
import { I18nLoader } from '../loaders';
import { ValidatorOptions } from 'class-validator';
export interface OptionsProvider {
    options: any;
}
export type I18nViewEngine = 'hbs' | 'handlebars' | 'pug' | 'ejs' | 'eta' | 'nunjucks';
export type OptionProvider<T = any> = Omit<ClassProvider<T>, 'provide'> | Omit<ValueProvider<T>, 'provide'> | Omit<FactoryProvider<T>, 'provide'> | Omit<ExistingProvider<T>, 'provide'> | OptionsProvider;
export interface ResolverWithOptionsBase {
    use: Type<I18nResolver>;
}
export type ResolverWithOptions = ResolverWithOptionsBase & OptionProvider;
export type I18nOptionsWithoutResolvers = Omit<I18nOptions, 'resolvers' | 'loader'>;
export type I18nOptionResolver = ResolverWithOptions | Type<I18nResolver> | I18nResolver;
export type Formatter = (template: string, ...args: (string | Record<string, string>)[]) => string;
export interface I18nFallbacks {
    [key: string]: string;
}
export interface I18nICUOptions {
    biDiSupport?: boolean;
    formatters?: Record<string, (...args: any[]) => any>;
    strictNumberSign?: boolean;
}
export interface I18nOptions {
    fallbackLanguage: string;
    fallbacks?: I18nFallbacks;
    resolvers?: I18nOptionResolver[];
    loader?: Type<I18nLoader>;
    loaderOptions?: any;
    loaders?: I18nLoader[];
    formatter?: Formatter;
    logging?: boolean;
    viewEngine?: I18nViewEngine;
    disableMiddleware?: boolean;
    skipAsyncHook?: boolean;
    validatorOptions?: I18nValidatorOptions;
    throwOnMissingKey?: boolean;
    keySeparator?: string | false;
    nsSeparator?: string | false;
    returnObjects?: boolean;
    joinArrays?: string;
    typesOutputPath?: string;
    useICU?: boolean;
    icuOptions?: I18nICUOptions;
    icuLocales?: string[];
}
export interface I18nOptionsFactory {
    createI18nOptions(): Promise<I18nOptionsWithoutResolvers> | I18nOptionsWithoutResolvers;
}
export interface I18nAsyncOptions extends Pick<ModuleMetadata, 'imports'> {
    name?: string;
    useExisting?: Type<I18nOptionsFactory>;
    useClass?: Type<I18nOptionsFactory>;
    useFactory?: (...args: any[]) => Promise<I18nOptionsWithoutResolvers> | I18nOptionsWithoutResolvers;
    resolvers?: I18nOptionResolver[];
    loader?: Type<I18nLoader>;
    loaders?: I18nLoader[];
    inject?: any[];
    logging?: boolean;
}
export type I18nValidatorOptions = ValidatorOptions;