Interface: ComposerOptions<Schema, Locales, MessagesLocales, DateTimeFormatsLocales, NumberFormatsLocales, MessageSchema, DateTimeSchema, NumberSchema, _Messages, _DateTimeFormats, _NumberFormats>

Composer Options

Signature

export interface ComposerOptions<
  Schema extends {
    message?: unknown
    datetime?: unknown
    number?: unknown
  } = {
    message: DefaultLocaleMessageSchema
    datetime: DefaultDateTimeFormatSchema
    number: DefaultNumberFormatSchema
  },
  Locales extends
    | {
        messages: unknown
        datetimeFormats: unknown
        numberFormats: unknown
      }
    | string = Locale,
  MessagesLocales = Locales extends { messages: infer M }
    ? M
    : Locales extends string
      ? Locales
      : Locale,
  DateTimeFormatsLocales = Locales extends { datetimeFormats: infer D }
    ? D
    : Locales extends string
      ? Locales
      : Locale,
  NumberFormatsLocales = Locales extends { numberFormats: infer N }
    ? N
    : Locales extends string
      ? Locales
      : Locale,
  MessageSchema = Schema extends { message: infer M } ? M : DefaultLocaleMessageSchema,
  DateTimeSchema = Schema extends { datetime: infer D } ? D : DefaultDateTimeFormatSchema,
  NumberSchema = Schema extends { number: infer N } ? N : DefaultNumberFormatSchema,
  _Messages extends LocaleMessages<MessageSchema, MessagesLocales, VueMessageType> = LocaleMessages<
    MessageSchema,
    MessagesLocales,
    VueMessageType
  >,
  _DateTimeFormats extends DateTimeFormatsType<DateTimeSchema, DateTimeFormatsLocales> =
    DateTimeFormatsType<DateTimeSchema, DateTimeFormatsLocales>,
  _NumberFormats extends NumberFormatsType<NumberSchema, NumberFormatsLocales> = NumberFormatsType<
    NumberSchema,
    NumberFormatsLocales
  >
>

Type Parameters

Name
Schema extends { message?: unknown datetime?: unknown number?: unknown } = { message: DefaultLocaleMessageSchema datetime: DefaultDateTimeFormatSchema number: DefaultNumberFormatSchema }
Locales extends | { messages: unknown datetimeFormats: unknown numberFormats: unknown } | string = Locale
MessagesLocales = Locales extends { messages: infer M } ? M : Locales extends string ? Locales : Locale
DateTimeFormatsLocales = Locales extends { datetimeFormats: infer D } ? D : Locales extends string ? Locales : Locale
NumberFormatsLocales = Locales extends { numberFormats: infer N } ? N : Locales extends string ? Locales : Locale
MessageSchema = Schema extends { message: infer M } ? M : DefaultLocaleMessageSchema
DateTimeSchema = Schema extends { datetime: infer D } ? D : DefaultDateTimeFormatSchema
NumberSchema = Schema extends { number: infer N } ? N : DefaultNumberFormatSchema
_Messages extends LocaleMessages<MessageSchema, MessagesLocales, VueMessageType> = LocaleMessages<MessageSchema, MessagesLocales, VueMessageType>
_DateTimeFormats extends DateTimeFormatsType<DateTimeSchema, DateTimeFormatsLocales> = DateTimeFormatsType<DateTimeSchema, DateTimeFormatsLocales>
_NumberFormats extends NumberFormatsType<NumberSchema, NumberFormatsLocales> = NumberFormatsType<NumberSchema, NumberFormatsLocales>

Properties

Name	Type	Description
datetimeFormats (optional)	{ [K in keyof _DateTimeFormats]: DateTimeSchema }	Default: {}
escapeParameter (optional)	boolean	Default: false
fallbackFormat (optional)	boolean	Default: false
fallbackLocale (optional)	FallbackLocale	Default: The default 'en-US'for thelocaleif it's not specified, or it'slocale value
fallbackRoot (optional)	boolean	Default: true
fallbackWarn (optional)	boolean | RegExp	Default: true
flatJson (optional)	boolean	Default: false
inheritLocale (optional)	boolean	Default: true
locale (optional)	Locale	Default: 'en-US'
localeFallbacker (optional)	LocaleFallbacker	Default: undefined
messageCompiler (optional)	MessageCompiler	Default: undefined
messageResolver (optional)	MessageResolver	Default: undefined
messages (optional)	{ [K in keyof _Messages]: MessageSchema }	Default: {}
missing (optional)	MissingHandler	Default: null
missingWarn (optional)	boolean | RegExp	Default: true
modifiers (optional)	LinkedModifiers<VueMessageType>
numberFormats (optional)	{ [K in keyof _NumberFormats]: NumberSchema }	Default: {}
pluralRules (optional)	PluralizationRules	Default: {}
postTranslation (optional)	PostTranslationHandler<VueMessageType>	Default: null
warnHtmlMessage (optional)	boolean	Default: true

missing Parameters

Name	Type	Description
locale	Locale
key	Path
uid	number	optional
type	string	optional

missing Returns

string | void

Tags

• @VueI18nComposition
• @remarks — This is options to create composer.