core-base.d.ts 57 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259
  1. import type { BaseError } from '@intlify/shared';
  2. import { CompileError } from '@intlify/message-compiler';
  3. import { CompileErrorCodes } from '@intlify/message-compiler';
  4. import type { CompileOptions } from '@intlify/message-compiler';
  5. import type { CoreMissingType as CoreMissingType_2 } from '@intlify/core-base';
  6. import { createCompileError } from '@intlify/message-compiler';
  7. import type { Emittable } from '@intlify/shared';
  8. import type { Locale as Locale_2 } from '@intlify/core-base';
  9. import type { MessageFunction as MessageFunction_2 } from '@intlify/core-base';
  10. import type { Path as Path_2 } from '@intlify/core-base';
  11. import type { PathValue as PathValue_2 } from '@intlify/core-base';
  12. import { ResourceNode } from '@intlify/message-compiler';
  13. import type { ResourceNode as ResourceNode_2 } from '@intlify/core-base';
  14. declare type __ResourceFormatPath<T, Key extends keyof T> = Key extends string ? T[Key] extends Record<string, any> ? `${Key}` : never : never;
  15. export declare type __ResourcePath<T, Key extends keyof T> = Key extends string ? T[Key] extends Record<string, any> ? `${Key}.${__ResourcePath<T[Key], Exclude<keyof T[Key], keyof any[]>> & string}` | `${Key}.${Exclude<keyof T[Key], keyof any[]> & string}` : never : never;
  16. declare type AdditionalPayloads = {
  17. meta?: Record<string, unknown>;
  18. };
  19. export declare function clearCompileCache(): void;
  20. /* Excluded from this release type: clearDateTimeFormat */
  21. /* Excluded from this release type: clearNumberFormat */
  22. export declare function compile<Message = string, MessageSource = string | ResourceNode>(message: MessageSource, context: MessageCompilerContext): MessageFunction<Message>;
  23. export { CompileError }
  24. export { CompileErrorCodes }
  25. export declare const compileToFunction: <Message = string, MessageSource = string | ResourceNode>(message: MessageSource, context: MessageCompilerContext) => MessageFunction<Message>;
  26. export declare interface CoreCommonContext<Message = string, Locales = 'en-US'> {
  27. cid: number;
  28. version: string;
  29. locale: Locales;
  30. fallbackLocale: FallbackLocales<Exclude<Locales, LocaleDetector>>;
  31. missing: CoreMissingHandler<Message> | null;
  32. missingWarn: boolean | RegExp;
  33. fallbackWarn: boolean | RegExp;
  34. fallbackFormat: boolean;
  35. unresolving: boolean;
  36. localeFallbacker: LocaleFallbacker;
  37. onWarn(msg: string, err?: Error): void;
  38. }
  39. export declare type CoreContext<Message = string, Messages = {}, DateTimeFormats = {}, NumberFormats = {}, LocaleType = Locale, ResourceLocales = PickupLocales<NonNullable<Messages>> | PickupLocales<NonNullable<DateTimeFormats>> | PickupLocales<NonNullable<NumberFormats>>, Locales = IsNever<ResourceLocales> extends true ? LocaleType extends LocaleDetector | Locale ? LocaleType : Locale : ResourceLocales> = CoreCommonContext<Message, Locales> & CoreTranslationContext<NonNullable<Messages>, Message> & CoreDateTimeContext<NonNullable<DateTimeFormats>> & CoreNumberContext<NonNullable<NumberFormats>> & {
  40. fallbackContext?: CoreContext<Message, Messages, DateTimeFormats, NumberFormats, LocaleType, ResourceLocales, Locales>;
  41. };
  42. export declare interface CoreDateTimeContext<DateTimeFormats = {}> {
  43. datetimeFormats: {
  44. [K in keyof DateTimeFormats]: DateTimeFormats[K];
  45. };
  46. }
  47. export declare interface CoreError extends BaseError {
  48. }
  49. export declare const CoreErrorCodes: {
  50. readonly INVALID_ARGUMENT: 17;
  51. readonly INVALID_DATE_ARGUMENT: number;
  52. readonly INVALID_ISO_DATE_ARGUMENT: number;
  53. readonly NOT_SUPPORT_NON_STRING_MESSAGE: number;
  54. readonly NOT_SUPPORT_LOCALE_PROMISE_VALUE: number;
  55. readonly NOT_SUPPORT_LOCALE_ASYNC_FUNCTION: number;
  56. readonly NOT_SUPPORT_LOCALE_TYPE: number;
  57. readonly __EXTEND_POINT__: number;
  58. };
  59. export declare type CoreErrorCodes = (typeof CoreErrorCodes)[keyof typeof CoreErrorCodes];
  60. export declare interface CoreInternalContext {
  61. __datetimeFormatters: Map<string, Intl.DateTimeFormat>;
  62. __numberFormatters: Map<string, Intl.NumberFormat>;
  63. __localeChainCache?: Map<Locale, Locale[]>;
  64. __v_emitter?: VueDevToolsEmitter;
  65. __meta: MetaInfo;
  66. }
  67. export declare interface CoreInternalOptions {
  68. __datetimeFormatters?: Map<string, Intl.DateTimeFormat>;
  69. __numberFormatters?: Map<string, Intl.NumberFormat>;
  70. __v_emitter?: VueDevToolsEmitter;
  71. __meta?: MetaInfo;
  72. }
  73. export declare type CoreMissingHandler<Message = string> = (context: CoreContext<Message>, locale: Locale, key: Path, type: CoreMissingType, ...values: unknown[]) => string | void;
  74. export declare type CoreMissingType = 'translate' | 'datetime format' | 'number format' | 'translate exists';
  75. export declare interface CoreNumberContext<NumberFormats = {}> {
  76. numberFormats: {
  77. [K in keyof NumberFormats]: NumberFormats[K];
  78. };
  79. }
  80. export declare interface CoreOptions<Message = string, Schema extends {
  81. message?: unknown;
  82. datetime?: unknown;
  83. number?: unknown;
  84. } = {
  85. message: DefaultCoreLocaleMessageSchema;
  86. datetime: DateTimeFormat;
  87. number: NumberFormat;
  88. }, Locales extends {
  89. messages: unknown;
  90. datetimeFormats: unknown;
  91. numberFormats: unknown;
  92. } | string = Locale, MessagesLocales = Locales extends {
  93. messages: infer M;
  94. } ? M : Locales extends string ? Locales : Locale, DateTimeFormatsLocales = Locales extends {
  95. datetimeFormats: infer D;
  96. } ? D : Locales extends string ? Locales : Locale, NumberFormatsLocales = Locales extends {
  97. numberFormats: infer N;
  98. } ? N : Locales extends string ? Locales : Locale, MessageSchema = Schema extends {
  99. message: infer M;
  100. } ? M : DefaultCoreLocaleMessageSchema, DateTimeSchema = Schema extends {
  101. datetime: infer D;
  102. } ? D : DateTimeFormat, NumberSchema = Schema extends {
  103. number: infer N;
  104. } ? N : NumberFormat, _Messages extends LocaleMessages<MessageSchema, MessagesLocales, Message> = LocaleMessages<MessageSchema, MessagesLocales, Message>, _DateTimeFormats extends DateTimeFormats<DateTimeSchema, DateTimeFormatsLocales> = DateTimeFormats<DateTimeSchema, DateTimeFormatsLocales>, _NumberFormats extends NumberFormats<NumberSchema, NumberFormatsLocales> = NumberFormats<NumberSchema, NumberFormatsLocales>> {
  105. version?: string;
  106. locale?: Locale | LocaleDetector;
  107. fallbackLocale?: FallbackLocale;
  108. messages?: {
  109. [K in keyof _Messages]: MessageSchema;
  110. };
  111. datetimeFormats?: {
  112. [K in keyof _DateTimeFormats]: DateTimeSchema;
  113. };
  114. numberFormats?: {
  115. [K in keyof _NumberFormats]: NumberSchema;
  116. };
  117. modifiers?: LinkedModifiers<Message>;
  118. pluralRules?: PluralizationRules;
  119. missing?: CoreMissingHandler<Message>;
  120. missingWarn?: boolean | RegExp;
  121. fallbackWarn?: boolean | RegExp;
  122. fallbackFormat?: boolean;
  123. unresolving?: boolean;
  124. postTranslation?: PostTranslationHandler<Message>;
  125. processor?: MessageProcessor<Message>;
  126. warnHtmlMessage?: boolean;
  127. escapeParameter?: boolean;
  128. messageCompiler?: MessageCompiler<Message, string | ResourceNode>;
  129. messageResolver?: MessageResolver;
  130. localeFallbacker?: LocaleFallbacker;
  131. fallbackContext?: CoreContext<Message, MessagesLocales, DateTimeFormatsLocales, NumberFormatsLocales>;
  132. onWarn?: (msg: string, err?: Error) => void;
  133. }
  134. export declare interface CoreTranslationContext<Messages = {}, Message = string> {
  135. messages: {
  136. [K in keyof Messages]: Messages[K];
  137. };
  138. modifiers: LinkedModifiers<Message>;
  139. pluralRules?: PluralizationRules;
  140. postTranslation: PostTranslationHandler<Message> | null;
  141. processor: MessageProcessor<Message> | null;
  142. warnHtmlMessage: boolean;
  143. escapeParameter: boolean;
  144. messageCompiler: MessageCompiler<Message, string | ResourceNode> | null;
  145. messageResolver: MessageResolver;
  146. }
  147. export declare const CoreWarnCodes: {
  148. readonly NOT_FOUND_KEY: 1;
  149. readonly FALLBACK_TO_TRANSLATE: 2;
  150. readonly CANNOT_FORMAT_NUMBER: 3;
  151. readonly FALLBACK_TO_NUMBER_FORMAT: 4;
  152. readonly CANNOT_FORMAT_DATE: 5;
  153. readonly FALLBACK_TO_DATE_FORMAT: 6;
  154. readonly EXPERIMENTAL_CUSTOM_MESSAGE_COMPILER: 7;
  155. readonly __EXTEND_POINT__: 8;
  156. };
  157. export declare type CoreWarnCodes = (typeof CoreWarnCodes)[keyof typeof CoreWarnCodes];
  158. export { createCompileError }
  159. export declare function createCoreContext<Message = string, Options extends CoreOptions<Message> = CoreOptions<Message>, Messages extends Record<string, any> = Options['messages'] extends Record<string, any> ? Options['messages'] : {}, DateTimeFormats extends Record<string, any> = Options['datetimeFormats'] extends Record<string, any> ? Options['datetimeFormats'] : {}, NumberFormats extends Record<string, any> = Options['numberFormats'] extends Record<string, any> ? Options['numberFormats'] : {}, LocaleType = Locale | LocaleDetector>(options: Options): CoreContext<Message, Messages, DateTimeFormats, NumberFormats, LocaleType>;
  160. export declare function createCoreContext<Schema = LocaleMessage, Locales = 'en-US', Message = string, Options extends CoreOptions<Message, SchemaParams<Schema, Message>, LocaleParams<Locales>> = CoreOptions<Message, SchemaParams<Schema, Message>, LocaleParams<Locales>>, Messages extends Record<string, any> = NonNullable<Options['messages']> extends Record<string, any> ? NonNullable<Options['messages']> : {}, DateTimeFormats extends Record<string, any> = NonNullable<Options['datetimeFormats']> extends Record<string, any> ? NonNullable<Options['datetimeFormats']> : {}, NumberFormats extends Record<string, any> = NonNullable<Options['numberFormats']> extends Record<string, any> ? NonNullable<Options['numberFormats']> : {}, LocaleType = Locale | LocaleDetector>(options: Options): CoreContext<Message, Messages, DateTimeFormats, NumberFormats, LocaleType>;
  161. export declare function createCoreError(code: CoreErrorCodes): CoreError;
  162. export declare function createMessageContext<T = string, N = {}>(options?: MessageContextOptions<T, N>): MessageContext<T>;
  163. /**
  164. * number
  165. */
  166. export declare type CurrencyDisplay = 'symbol' | 'code' | 'name';
  167. export declare interface CurrencyNumberFormatOptions extends Intl.NumberFormatOptions {
  168. style: 'currency';
  169. currency: string;
  170. currencyDisplay?: CurrencyDisplay;
  171. localeMatcher?: LocaleMatcher;
  172. formatMatcher?: FormatMatcher;
  173. }
  174. /**
  175. * `datetime` function overloads
  176. */
  177. export declare function datetime<Context extends CoreContext<Message, {}, {}, {}>, Message = string>(context: Context, value: number | string | Date): string | number | Intl.DateTimeFormatPart[];
  178. export declare function datetime<Context extends CoreContext<Message, {}, {}, {}>, Value extends number | string | Date = number, Key extends string = string, ResourceKeys extends PickupFormatKeys<Context['datetimeFormats']> = PickupFormatKeys<Context['datetimeFormats']>, Message = string>(context: Context, value: Value, keyOrOptions: Key | ResourceKeys | DateTimeOptions<Key | ResourceKeys, Context['locale']>): string | number | Intl.DateTimeFormatPart[];
  179. export declare function datetime<Context extends CoreContext<Message, {}, {}, {}>, Value extends number | string | Date = number, Key extends string = string, ResourceKeys extends PickupFormatKeys<Context['datetimeFormats']> = PickupFormatKeys<Context['datetimeFormats']>, Message = string>(context: Context, value: Value, keyOrOptions: Key | ResourceKeys | DateTimeOptions<Key | ResourceKeys, Context['locale']>, locale: Context['locale']): string | number | Intl.DateTimeFormatPart[];
  180. export declare function datetime<Context extends CoreContext<Message, {}, {}, {}>, Value extends number | string | Date = number, Key extends string = string, ResourceKeys extends PickupFormatKeys<Context['datetimeFormats']> = PickupFormatKeys<Context['datetimeFormats']>, Message = string>(context: Context, value: Value, keyOrOptions: Key | ResourceKeys | DateTimeOptions<Key | ResourceKeys, Context['locale']>, override: Intl.DateTimeFormatOptions): string | number | Intl.DateTimeFormatPart[];
  181. export declare function datetime<Context extends CoreContext<Message, {}, {}, {}>, Value extends number | string | Date = number, Key extends string = string, ResourceKeys extends PickupFormatKeys<Context['datetimeFormats']> = PickupFormatKeys<Context['datetimeFormats']>, Message = string>(context: Context, value: Value, keyOrOptions: Key | ResourceKeys | DateTimeOptions<Key | ResourceKeys, Context['locale']>, locale: Context['locale'], override: Intl.DateTimeFormatOptions): string | number | Intl.DateTimeFormatPart[];
  182. /* Excluded from this release type: DATETIME_FORMAT_OPTIONS_KEYS */
  183. export declare type DateTimeDigital = 'numeric' | '2-digit';
  184. export declare type DateTimeFormat = {
  185. [key: string]: DateTimeFormatOptions;
  186. };
  187. export declare type DateTimeFormatOptions = Intl.DateTimeFormatOptions | SpecificDateTimeFormatOptions;
  188. export declare type DateTimeFormats<Schema = DateTimeFormat, Locales = Locale> = LocaleRecord<UnionToTuple<Locales>, Schema>;
  189. /**
  190. * datetime
  191. */
  192. export declare type DateTimeHumanReadable = 'long' | 'short' | 'narrow';
  193. /**
  194. * # datetime
  195. *
  196. * ## usages:
  197. * // for example `context.datetimeFormats` below
  198. * 'en-US': {
  199. * short: {
  200. * year: 'numeric', month: '2-digit', day: '2-digit',
  201. * hour: '2-digit', minute: '2-digit'
  202. * }
  203. * },
  204. * 'ja-JP': { ... }
  205. *
  206. * // datetimeable value only
  207. * datetime(context, value)
  208. *
  209. * // key argument
  210. * datetime(context, value, 'short')
  211. *
  212. * // key & locale argument
  213. * datetime(context, value, 'short', 'ja-JP')
  214. *
  215. * // object sytle argument
  216. * datetime(context, value, { key: 'short', locale: 'ja-JP' })
  217. *
  218. * // suppress localize miss warning option, override context.missingWarn
  219. * datetime(context, value, { key: 'short', locale: 'ja-JP', missingWarn: false })
  220. *
  221. * // suppress localize fallback warning option, override context.fallbackWarn
  222. * datetime(context, value, { key: 'short', locale: 'ja-JP', fallbackWarn: false })
  223. *
  224. * // if you specify `part` options, you can get an array of objects containing the formatted datetime in parts
  225. * datetime(context, value, { key: 'short', part: true })
  226. *
  227. * // orverride context.datetimeFormats[locale] options with functino options
  228. * datetime(cnotext, value, 'short', { year: '2-digit' })
  229. * datetime(cnotext, value, 'short', 'ja-JP', { year: '2-digit' })
  230. * datetime(context, value, { key: 'short', part: true, year: '2-digit' })
  231. */
  232. /**
  233. * DateTime options
  234. *
  235. * @remarks
  236. * Options for Datetime formatting API
  237. *
  238. * @VueI18nGeneral
  239. */
  240. export declare interface DateTimeOptions<Key = string, Locales = Locale> extends Intl.DateTimeFormatOptions, LocaleOptions<Locales> {
  241. /**
  242. * @remarks
  243. * The target format key
  244. */
  245. key?: Key;
  246. /**
  247. * @remarks
  248. * Whether suppress warnings outputted when localization fails
  249. */
  250. missingWarn?: boolean;
  251. /**
  252. * @remarks
  253. * Whether do resolve on format keys when your language lacks a formatting for a key
  254. */
  255. fallbackWarn?: boolean;
  256. /**
  257. * @remarks
  258. * Whether to use [Intel.DateTimeFormat#formatToParts](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/formatToParts)
  259. */
  260. part?: boolean;
  261. }
  262. export declare const DEFAULT_LOCALE = "en-US";
  263. export declare const DEFAULT_MESSAGE_DATA_TYPE = "text";
  264. export declare type DefaultCoreLocaleMessageSchema<Schema = RemoveIndexSignature<{
  265. [K in keyof DefineCoreLocaleMessage]: DefineCoreLocaleMessage[K];
  266. }>> = IsEmptyObject<Schema> extends true ? LocaleMessage<string> : Schema;
  267. /**
  268. * The type definition of Locale Message for `@intlify/core-base` package
  269. *
  270. * @remarks
  271. * The typealias is used to strictly define the type of the Locale message.
  272. *
  273. * @example
  274. * ```ts
  275. * // type.d.ts (`.d.ts` file at your app)
  276. * import { DefineCoreLocaleMessage } from '@intlify/core-base'
  277. *
  278. * declare module '@intlify/core-base' {
  279. * export interface DefineCoreLocaleMessage {
  280. * title: string
  281. * menu: {
  282. * login: string
  283. * }
  284. * }
  285. * }
  286. * ```
  287. *
  288. * @VueI18nGeneral
  289. */
  290. export declare interface DefineCoreLocaleMessage extends LocaleMessage<string> {
  291. }
  292. declare type ExtractToStringFunction<T> = T[ExtractToStringKey<T>];
  293. declare type ExtractToStringKey<T> = Extract<keyof T, 'toString'>;
  294. /** @VueI18nGeneral */
  295. export declare type FallbackLocale = Locale | Locale[] | {
  296. [locale in string]: Locale[];
  297. } | false;
  298. export declare type FallbackLocales<Locales = 'en-US'> = Locales | Array<Locales> | {
  299. [locale in string]: Array<PickupFallbackLocales<UnionToTuple<Locales>>>;
  300. } | false;
  301. /**
  302. * Fallback with locale chain
  303. *
  304. * @remarks
  305. * A fallback locale function implemented with a fallback chain algorithm. It's used in VueI18n as default.
  306. *
  307. * @param ctx - A {@link CoreContext | context}
  308. * @param fallback - A {@link FallbackLocale | fallback locale}
  309. * @param start - A starting {@link Locale | locale}
  310. *
  311. * @returns Fallback locales
  312. *
  313. * @VueI18nSee [Fallbacking](../guide/essentials/fallback)
  314. *
  315. * @VueI18nGeneral
  316. */
  317. export declare function fallbackWithLocaleChain<Message = string>(ctx: CoreContext<Message>, fallback: FallbackLocale, start: Locale): Locale[];
  318. /**
  319. * Fallback with simple implemenation
  320. *
  321. * @remarks
  322. * A fallback locale function implemented with a simple fallback algorithm.
  323. *
  324. * Basically, it returns the value as specified in the `fallbackLocale` props, and is processed with the fallback inside intlify.
  325. *
  326. * @param ctx - A {@link CoreContext | context}
  327. * @param fallback - A {@link FallbackLocale | fallback locale}
  328. * @param start - A starting {@link Locale | locale}
  329. *
  330. * @returns Fallback locales
  331. *
  332. * @VueI18nGeneral
  333. */
  334. export declare function fallbackWithSimple<Message = string>(ctx: CoreContext<Message>, fallback: FallbackLocale, start: Locale): Locale[];
  335. export declare type First<T extends readonly any[]> = T[0];
  336. export declare type FormatMatcher = 'basic' | 'best fit';
  337. export declare type FormattedNumberPart = {
  338. type: FormattedNumberPartType;
  339. value: string;
  340. };
  341. export declare type FormattedNumberPartType = 'currency' | 'decimal' | 'fraction' | 'group' | 'infinity' | 'integer' | 'literal' | 'minusSign' | 'nan' | 'plusSign' | 'percentSign';
  342. export declare const getAdditionalMeta: () => MetaInfo | null;
  343. export declare function getDevToolsHook(): IntlifyDevToolsEmitter | null;
  344. export declare const getFallbackContext: () => CoreContext | null;
  345. /* Excluded from this release type: getLocale */
  346. export declare function getWarnMessage(code: CoreWarnCodes, ...args: unknown[]): string;
  347. /* Excluded from this release type: handleMissing */
  348. export declare function initI18nDevTools(i18n: unknown, version: string, meta?: Record<string, unknown>): void;
  349. declare type IntlifyDevToolsEmitter = Emittable<IntlifyDevToolsEmitterHooks>;
  350. declare type IntlifyDevToolsEmitterHooks = {
  351. [IntlifyDevToolsHooks.I18nInit]: IntlifyDevToolsHookPayloads[IntlifyDevToolsHooks.I18nInit];
  352. [IntlifyDevToolsHooks.FunctionTranslate]: IntlifyDevToolsHookPayloads[IntlifyDevToolsHooks.FunctionTranslate];
  353. };
  354. declare type IntlifyDevToolsHookPayloads = {
  355. [IntlifyDevToolsHooks.I18nInit]: {
  356. timestamp: number;
  357. i18n: unknown;
  358. version: string;
  359. } & AdditionalPayloads;
  360. [IntlifyDevToolsHooks.FunctionTranslate]: {
  361. timestamp: number;
  362. message: string | number;
  363. key: string;
  364. locale: string;
  365. format?: string;
  366. } & AdditionalPayloads;
  367. };
  368. declare const enum IntlifyDevToolsHooks {
  369. I18nInit = "i18n:init",
  370. FunctionTranslate = "function:translate"
  371. }
  372. export declare type IsEmptyObject<T> = IsNever<keyof T> extends true ? true : false;
  373. export declare const isMessageAST: (val: unknown) => val is ResourceNode;
  374. export declare const isMessageFunction: <T>(val: unknown) => val is MessageFunction<T>;
  375. export declare type IsNever<T> = [T] extends [never] ? true : false;
  376. /* Excluded from this release type: isTranslateFallbackWarn */
  377. /* Excluded from this release type: isTranslateMissingWarn */
  378. export declare type IsUnion<T, B = T> = T extends B ? [B] extends [T] ? false : true : never;
  379. export declare type LastInUnion<U> = UnionToIntersection<U extends unknown ? (x: U) => 0 : never> extends (x: infer L) => 0 ? L : never;
  380. /** @VueI18nGeneral */
  381. export declare type LinkedModifiers<T = string> = {
  382. [key: string]: LinkedModify<T>;
  383. };
  384. export declare type LinkedModify<T = string> = (value: T, type: string) => MessageType<T>;
  385. export declare interface LinkedOptions {
  386. /**
  387. * The message type of linked message
  388. */
  389. type?: string;
  390. /**
  391. * The modifier of linked message
  392. */
  393. modifier?: string;
  394. }
  395. /** @VueI18nGeneral */
  396. export declare type Locale = string;
  397. /** @VueI18nGeneral */
  398. export declare interface LocaleDetector<Args extends any[] = any[]> {
  399. (...args: Args): Locale | Promise<Locale>;
  400. resolvedOnce?: boolean;
  401. }
  402. /**
  403. * The locale fallbacker
  404. *
  405. * @VueI18nGeneral
  406. */
  407. export declare type LocaleFallbacker = <Message = string>(ctx: CoreContext<Message>, fallback: FallbackLocale, start: Locale) => Locale[];
  408. export declare type LocaleMatcher = 'lookup' | 'best fit';
  409. /** @VueI18nGeneral */
  410. export declare type LocaleMessage<Message = string> = Record<string, LocaleMessageValue<Message>>;
  411. /** @VueI18nGeneral */
  412. export declare type LocaleMessageDictionary<T, Message = string> = {
  413. [K in keyof T]: LocaleMessageType<T[K], Message>;
  414. };
  415. /** @VueI18nGeneral */
  416. export declare type LocaleMessages<Schema, Locales = Locale, Message = string> = LocaleRecord<UnionToTuple<Locales>, Schema>;
  417. /** @VueI18nGeneral */
  418. export declare type LocaleMessageType<T, Message = string> = T extends string ? string : T extends () => Promise<infer P> ? LocaleMessageDictionary<P, Message> : T extends (...args: infer Arguments) => any ? (...args: Arguments) => ReturnType<T> : T extends Record<string, unknown> ? LocaleMessageDictionary<T, Message> : T extends Array<T> ? {
  419. [K in keyof T]: T[K];
  420. } : T;
  421. /** @VueI18nGeneral */
  422. export declare type LocaleMessageValue<Message = string> = LocaleMessageDictionary<any, Message> | string;
  423. /** @VueI18nGeneral */
  424. export declare interface LocaleOptions<Locales = Locale> {
  425. /**
  426. * @remarks
  427. * The locale of localization
  428. */
  429. locale?: Locales | LocaleDetector;
  430. }
  431. export declare type LocaleParams<T, Default = 'en-US'> = T extends IsUnion<T> ? {
  432. messages: T;
  433. datetimeFormats: T;
  434. numberFormats: T;
  435. } : T extends {
  436. messages?: infer M;
  437. datetimeFormats?: infer D;
  438. numberFormats?: infer N;
  439. } ? {
  440. messages: LocaleParamsType<M, Default>;
  441. datetimeFormats: LocaleParamsType<D, Default>;
  442. numberFormats: LocaleParamsType<N, Default>;
  443. } : T extends string ? {
  444. messages: T;
  445. datetimeFormats: T;
  446. numberFormats: T;
  447. } : {
  448. messages: Default;
  449. datetimeFormats: Default;
  450. numberFormats: Default;
  451. };
  452. declare type LocaleParamsType<T, R> = T extends IsUnion<T> ? T : T extends string ? T : R;
  453. export declare type LocaleRecord<T extends any[], R> = {
  454. [K in T[number]]: R;
  455. };
  456. /**
  457. * The message compiler
  458. *
  459. * @param message - A resolved message that ususally will be passed the string. if you can transform to it with bundler, will be passed the AST.
  460. * @param context - A message context {@link MessageCompilerContext}
  461. *
  462. * @returns A {@link MessageFunction}
  463. *
  464. * @VueI18nGeneral
  465. */
  466. export declare type MessageCompiler<Message = string, MessageSource = string | ResourceNode> = (message: MessageSource, context: MessageCompilerContext) => MessageFunction<Message>;
  467. /**
  468. * The context that will pass the message compiler.
  469. *
  470. * @VueI18nGeneral
  471. */
  472. export declare type MessageCompilerContext = Pick<CompileOptions, 'onError' | 'onCacheKey'> & {
  473. /**
  474. * Whether to allow the use locale messages of HTML formatting.
  475. */
  476. warnHtmlMessage?: boolean;
  477. /**
  478. * The resolved locale message key
  479. */
  480. key: string;
  481. /**
  482. * The locale
  483. */
  484. locale: Locale;
  485. };
  486. /**
  487. * The message context.
  488. *
  489. * @VueI18nGeneral
  490. */
  491. export declare interface MessageContext<T = string> {
  492. /**
  493. * Resolve message value from list.
  494. *
  495. * @param index - An index of message values.
  496. *
  497. * @returns A resolved message value.
  498. *
  499. * @example
  500. * ```js
  501. * const messages = {
  502. * en: {
  503. * greeting: ({ list }) => `hello, ${list(0)}!`
  504. * }
  505. * }
  506. * ```
  507. */
  508. list(index: number): unknown;
  509. /**
  510. * Resolve message value from named.
  511. *
  512. * @param key - A key of message value.
  513. *
  514. * @returns A resolved message value.
  515. *
  516. * @example
  517. * ```js
  518. * const messages = {
  519. * en: {
  520. * greeting: ({ named }) => `hello, ${named('name')}!`
  521. * }
  522. * }
  523. * ```
  524. */
  525. named(key: string): unknown;
  526. /**
  527. * Resolve message with plural index.
  528. *
  529. * @remarks
  530. * That's resolved with plural index with translation function.
  531. *
  532. * @param messages - the messages, that is resolved with plural index with translation function.
  533. *
  534. * @returns A resolved message.
  535. *
  536. * @example
  537. * ```js
  538. * const messages = {
  539. * en: {
  540. * car: ({ plural }) => plural(['car', 'cars']),
  541. * apple: ({ plural, named }) =>
  542. * plural([
  543. * 'no apples',
  544. * 'one apple',
  545. * `${named('count')} apples`
  546. * ])
  547. * }
  548. * }
  549. * ```
  550. */
  551. plural(messages: T[]): T;
  552. /**
  553. * Resolve linked message.
  554. *
  555. * @param key - A message key
  556. * @param modifier - A modifier
  557. *
  558. * @returns A resolve message.
  559. */
  560. linked(key: Path, modifier?: string): MessageType<T>;
  561. /**
  562. * Overloaded `linked`
  563. *
  564. * @param key - A message key
  565. * @param modifier - A modifier
  566. * @param type - A message type
  567. *
  568. * @returns A resolve message.
  569. */
  570. linked(key: Path, modifier?: string, type?: string): MessageType<T>;
  571. /**
  572. * Overloaded `linked`
  573. *
  574. * @param key - A message key
  575. * @param optoins - An {@link LinkedOptions | linked options}
  576. *
  577. * @returns A resolve message.
  578. */
  579. linked(key: Path, optoins?: LinkedOptions): MessageType<T>;
  580. /* Excluded from this release type: message */
  581. /**
  582. * The message type to be handled by the message function.
  583. *
  584. * @remarks
  585. * Usually `text`, you need to return **string** in message function.
  586. */
  587. type: string;
  588. /* Excluded from this release type: interpolate */
  589. /* Excluded from this release type: normalize */
  590. /**
  591. * The message values.
  592. *
  593. * @remarks
  594. * The message values are the argument values passed from translation fucntion, such as `$t`, `t`, or `translate`.
  595. *
  596. * @example
  597. * vue-i18n `$t` (or `t`) case:
  598. * ```html
  599. * <p>{{ $t('greeting', { name: 'DIO' }) }}</p> <!-- `{ name: 'DIO' }` is message vlaues -->
  600. * ```
  601. *
  602. * `@intlify/core` (`@intlify/core-base`) `translate` case:
  603. * ```js
  604. * translate(context, 'foo.bar', ['dio']) // `['dio']` is message values
  605. * ```
  606. */
  607. values: Record<string, unknown>;
  608. }
  609. export declare interface MessageContextOptions<T = string, N = {}> {
  610. parent?: MessageContext<T>;
  611. locale?: string;
  612. list?: unknown[];
  613. named?: NamedValue<N>;
  614. modifiers?: LinkedModifiers<T>;
  615. pluralIndex?: number;
  616. pluralRules?: PluralizationRules;
  617. messages?: MessageFunctions<T> | MessageResolveFunction<T>;
  618. processor?: MessageProcessor<T>;
  619. }
  620. /**
  621. * The Message Function.
  622. *
  623. * @param ctx - A {@link MessageContext}
  624. *
  625. * @return A resolved format message, that is string type basically.
  626. *
  627. * @VueI18nGeneral
  628. */
  629. export declare type MessageFunction<T = string> = MessageFunctionCallable | MessageFunctionInternal<T>;
  630. export declare type MessageFunctionCallable = <T = string>(ctx: MessageContext<T>) => MessageFunctionReturn<T>;
  631. export declare type MessageFunctionInternal<T = string> = {
  632. (ctx: MessageContext<T>): MessageFunctionReturn<T>;
  633. key?: string;
  634. locale?: string;
  635. source?: string;
  636. };
  637. /** @VueI18nGeneral */
  638. export declare type MessageFunctionReturn<T = string> = T extends string ? MessageType<T> : MessageType<T>[];
  639. export declare type MessageFunctions<T = string> = Record<string, MessageFunction<T>>;
  640. export declare type MessageInterpolate<T = string> = (val: unknown) => MessageType<T>;
  641. export declare type MessageNormalize<T = string> = (values: MessageType<T>[]) => MessageFunctionReturn<T>;
  642. export declare interface MessageProcessor<T = string> {
  643. type?: string;
  644. interpolate?: MessageInterpolate<T>;
  645. normalize?: MessageNormalize<T>;
  646. }
  647. export declare type MessageResolveFunction<T = string> = (key: string) => MessageFunction<T>;
  648. /** @VueI18nGeneral */
  649. export declare type MessageResolver = (obj: unknown, path: Path) => PathValue;
  650. export declare type MessageType<T = string> = T extends string ? string : StringConvertable<T>;
  651. export declare interface MetaInfo {
  652. [field: string]: unknown;
  653. }
  654. export declare const MISSING_RESOLVE_VALUE = "";
  655. /** @VueI18nGeneral */
  656. export declare type NamedValue<T = {}> = T & Record<string, unknown>;
  657. export declare const NOT_REOSLVED = -1;
  658. /**
  659. * `number` function overloads
  660. */
  661. export declare function number<Context extends CoreContext<Message, {}, {}, {}>, Message = string>(context: Context, value: number): string | number | Intl.NumberFormatPart[];
  662. export declare function number<Context extends CoreContext<Message, {}, {}, {}>, Value extends number = number, Key extends string = string, ResourceKeys extends PickupFormatKeys<Context['numberFormats']> = PickupFormatKeys<Context['numberFormats']>, Message = string>(context: Context, value: Value, keyOrOptions: Key | ResourceKeys | NumberOptions<Key | ResourceKeys, Context['locale']>): string | number | Intl.NumberFormatPart[];
  663. export declare function number<Context extends CoreContext<Message, {}, {}, {}>, Value extends number = number, Key extends string = string, ResourceKeys extends PickupFormatKeys<Context['numberFormats']> = PickupFormatKeys<Context['numberFormats']>, Message = string>(context: Context, value: Value, keyOrOptions: Key | ResourceKeys | NumberOptions<Key | ResourceKeys, Context['locale']>, locale: Context['locale']): string | number | Intl.NumberFormatPart[];
  664. export declare function number<Context extends CoreContext<Message, {}, {}, {}>, Value extends number = number, Key extends string = string, ResourceKeys extends PickupFormatKeys<Context['numberFormats']> = PickupFormatKeys<Context['numberFormats']>, Message = string>(context: Context, value: Value, keyOrOptions: Key | ResourceKeys | NumberOptions<Key | ResourceKeys, Context['locale']>, override: Intl.NumberFormatOptions): string | number | Intl.NumberFormatPart[];
  665. export declare function number<Context extends CoreContext<Message, {}, {}, {}>, Value extends number = number, Key extends string = string, ResourceKeys extends PickupFormatKeys<Context['numberFormats']> = PickupFormatKeys<Context['numberFormats']>, Message = string>(context: Context, value: Value, keyOrOptions: Key | ResourceKeys | NumberOptions<Key | ResourceKeys, Context['locale']>, locale: Context['locale'], override: Intl.NumberFormatOptions): string | number | Intl.NumberFormatPart[];
  666. /* Excluded from this release type: NUMBER_FORMAT_OPTIONS_KEYS */
  667. export declare type NumberFormat = {
  668. [key: string]: NumberFormatOptions;
  669. };
  670. export declare type NumberFormatOptions = Intl.NumberFormatOptions | SpecificNumberFormatOptions | CurrencyNumberFormatOptions;
  671. export declare type NumberFormats<Schema = NumberFormat, Locales = Locale> = LocaleRecord<UnionToTuple<Locales>, Schema>;
  672. export declare type NumberFormatToPartsResult = {
  673. [index: number]: FormattedNumberPart;
  674. };
  675. /**
  676. * # number
  677. *
  678. * ## usages
  679. * // for example `context.numberFormats` below
  680. * 'en-US': {
  681. * 'currency': {
  682. * style: 'currency', currency: 'USD', currencyDisplay: 'symbol'
  683. * }
  684. * },
  685. * 'ja-JP: { ... }
  686. *
  687. * // value only
  688. * number(context, value)
  689. *
  690. * // key argument
  691. * number(context, value, 'currency')
  692. *
  693. * // key & locale argument
  694. * number(context, value, 'currency', 'ja-JP')
  695. *
  696. * // object sytle argument
  697. * number(context, value, { key: 'currency', locale: 'ja-JP' })
  698. *
  699. * // suppress localize miss warning option, override context.missingWarn
  700. * number(context, value, { key: 'currency', locale: 'ja-JP', missingWarn: false })
  701. *
  702. * // suppress localize fallback warning option, override context.fallbackWarn
  703. * number(context, value, { key: 'currency', locale: 'ja-JP', fallbackWarn: false })
  704. *
  705. * // if you specify `part` options, you can get an array of objects containing the formatted number in parts
  706. * number(context, value, { key: 'currenty', part: true })
  707. *
  708. * // orverride context.numberFormats[locale] options with functino options
  709. * number(cnotext, value, 'currency', { year: '2-digit' })
  710. * number(cnotext, value, 'currency', 'ja-JP', { year: '2-digit' })
  711. * number(context, value, { key: 'currenty', locale: 'ja-JP', part: true, year: '2-digit'})
  712. */
  713. /**
  714. * Number Options
  715. *
  716. * @remarks
  717. * Options for Number formatting API
  718. *
  719. * @VueI18nGeneral
  720. */
  721. export declare interface NumberOptions<Key = string, Locales = Locale> extends Intl.NumberFormatOptions, LocaleOptions<Locales> {
  722. /**
  723. * @remarks
  724. * The target format key
  725. */
  726. key?: Key;
  727. /**
  728. * @remarks
  729. * Whether suppress warnings outputted when localization fails
  730. */
  731. missingWarn?: boolean;
  732. /**
  733. * @remarks
  734. * Whether do resolve on format keys when your language lacks a formatting for a key
  735. */
  736. fallbackWarn?: boolean;
  737. /**
  738. * @remarks
  739. * Whether to use [Intel.NumberFormat#formatToParts](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/formatToParts)
  740. */
  741. part?: boolean;
  742. }
  743. /**
  744. * Parse a string path into an array of segments
  745. */
  746. export declare function parse(path: Path): string[] | undefined;
  747. /* Excluded from this release type: parseDateTimeArgs */
  748. /* Excluded from this release type: parseNumberArgs */
  749. /* Excluded from this release type: parseTranslateArgs */
  750. /** @VueI18nGeneral */
  751. export declare type Path = string;
  752. /** @VueI18nGeneral */
  753. export declare type PathValue = string | number | boolean | Function | null | {
  754. [key: string]: PathValue;
  755. } | PathValue[];
  756. export declare type PickupFallbackLocales<T extends any[]> = T[number] | `${T[number]}!`;
  757. export declare type PickupFormatKeys<T extends Record<string, any>, K = keyof T> = K extends string ? ResourceFormatPath<T[K]> : never;
  758. export declare type PickupFormatPathKeys<T extends object> = ResourceFormatPath<T>;
  759. export declare type PickupKeys<T extends Record<string, any>, K = keyof T> = K extends string ? ResourcePath<T[K]> : never;
  760. export declare type PickupLocales<T extends Record<string, any>, K = keyof T> = K extends string ? K : never;
  761. export declare type PickupPaths<T extends object> = ResourcePath<T>;
  762. export declare type PluralizationProps = {
  763. n?: number;
  764. count?: number;
  765. };
  766. export declare type PluralizationRule = (choice: number, choicesLength: number, orgRule?: PluralizationRule) => number;
  767. /** @VueI18nGeneral */
  768. export declare type PluralizationRules = {
  769. [locale: string]: PluralizationRule;
  770. };
  771. /** @VueI18nGeneral */
  772. export declare type PostTranslationHandler<Message = string> = (translated: MessageFunctionReturn<Message>, key: string) => MessageFunctionReturn<Message>;
  773. /**
  774. * Register the locale fallbacker
  775. *
  776. * @param fallbacker - A {@link LocaleFallbacker} function
  777. *
  778. * @VueI18nGeneral
  779. */
  780. export declare function registerLocaleFallbacker(fallbacker: LocaleFallbacker): void;
  781. export declare function registerMessageCompiler<Message>(compiler: MessageCompiler<Message, string | ResourceNode>): void;
  782. /**
  783. * Register the message resolver
  784. *
  785. * @param resolver - A {@link MessageResolver} function
  786. *
  787. * @VueI18nGeneral
  788. */
  789. export declare function registerMessageResolver(resolver: MessageResolver): void;
  790. export declare type RemovedIndexResources<T> = RemoveIndexSignature<{
  791. [K in keyof T]: T[K];
  792. }>;
  793. export declare type RemoveIndexSignature<T> = {
  794. [K in keyof T as string extends K ? never : number extends K ? never : K]: T[K];
  795. };
  796. /* Excluded from this release type: resolveLocale */
  797. /**
  798. * message resolver
  799. *
  800. * @remarks
  801. * Resolves messages. messages with a hierarchical structure such as objects can be resolved. This resolver is used in VueI18n as default.
  802. *
  803. * @param obj - A target object to be resolved with path
  804. * @param path - A {@link Path | path} to resolve the value of message
  805. *
  806. * @returns A resolved {@link PathValue | path value}
  807. *
  808. * @VueI18nGeneral
  809. */
  810. export declare function resolveValue(obj: unknown, path: Path): PathValue;
  811. /**
  812. * key-value message resolver
  813. *
  814. * @remarks
  815. * Resolves messages with the key-value structure. Note that messages with a hierarchical structure such as objects cannot be resolved
  816. *
  817. * @param obj - A target object to be resolved with path
  818. * @param path - A {@link Path | path} to resolve the value of message
  819. *
  820. * @returns A resolved {@link PathValue | path value}
  821. *
  822. * @VueI18nGeneral
  823. */
  824. export declare function resolveWithKeyValue(obj: unknown, path: Path): PathValue;
  825. export declare type ResourceFormatPath<T> = _ResourceFormatPath<T> extends string | keyof T ? _ResourceFormatPath<T> : keyof T;
  826. declare type _ResourceFormatPath<T> = __ResourceFormatPath<T, keyof T> | keyof T;
  827. export { ResourceNode }
  828. export declare type ResourcePath<T> = _ResourcePath<T> extends string | keyof T ? _ResourcePath<T> : keyof T;
  829. export declare type _ResourcePath<T> = __ResourcePath<T, keyof T> | keyof T;
  830. export declare type ResourceValue<T, P extends ResourcePath<T>> = P extends `${infer Key}.${infer Rest}` ? Key extends keyof T ? Rest extends ResourcePath<T[Key]> ? ResourceValue<T[Key], Rest> : never : never : P extends keyof T ? T[P] : never;
  831. export declare type SchemaParams<T, Message = string> = T extends readonly any[] ? {
  832. message: First<T>;
  833. datetime: DateTimeFormat;
  834. number: NumberFormat;
  835. } : T extends {
  836. message?: infer M;
  837. datetime?: infer D;
  838. number?: infer N;
  839. } ? {
  840. message: M extends LocaleMessage<Message> ? M : LocaleMessage<Message>;
  841. datetime: D extends DateTimeFormat ? D : DateTimeFormat;
  842. number: N extends NumberFormat ? N : NumberFormat;
  843. } : {
  844. message: LocaleMessage<Message>;
  845. datetime: DateTimeFormat;
  846. number: NumberFormat;
  847. };
  848. export declare const setAdditionalMeta: (meta: MetaInfo | null) => void;
  849. export declare function setDevToolsHook(hook: IntlifyDevToolsEmitter | null): void;
  850. export declare const setFallbackContext: (context: CoreContext | null) => void;
  851. export declare interface SpecificDateTimeFormatOptions extends Intl.DateTimeFormatOptions {
  852. year?: DateTimeDigital;
  853. month?: DateTimeDigital | DateTimeHumanReadable;
  854. day?: DateTimeDigital;
  855. hour?: DateTimeDigital;
  856. minute?: DateTimeDigital;
  857. second?: DateTimeDigital;
  858. weekday?: DateTimeHumanReadable;
  859. era?: DateTimeHumanReadable;
  860. timeZoneName?: 'long' | 'short';
  861. localeMatcher?: LocaleMatcher;
  862. formatMatcher?: FormatMatcher;
  863. }
  864. export declare interface SpecificNumberFormatOptions extends Intl.NumberFormatOptions {
  865. style?: 'decimal' | 'percent';
  866. currency?: string;
  867. currencyDisplay?: CurrencyDisplay;
  868. localeMatcher?: LocaleMatcher;
  869. formatMatcher?: FormatMatcher;
  870. }
  871. declare type StringConvertable<T> = ExtractToStringKey<T> extends never ? unknown : ExtractToStringFunction<T> extends (...args: any) => string ? T : unknown;
  872. /**
  873. * TODO:
  874. * this type should be used (refactored) at `translate` type definition
  875. * (Unfortunately, using this type will result in key completion failure due to type mismatch...)
  876. */
  877. /**
  878. * `translate` function overloads
  879. */
  880. export declare function translate<Context extends CoreContext<Message>, Key extends string = string, DefinedLocaleMessage extends RemovedIndexResources<DefineCoreLocaleMessage> = RemovedIndexResources<DefineCoreLocaleMessage>, CoreMessages = IsEmptyObject<DefinedLocaleMessage> extends false ? PickupPaths<{
  881. [K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K];
  882. }> : never, ContextMessages = IsEmptyObject<Context['messages']> extends false ? PickupKeys<Context['messages']> : never, ResourceKeys extends CoreMessages | ContextMessages = IsNever<CoreMessages> extends false ? IsNever<ContextMessages> extends false ? CoreMessages | ContextMessages : CoreMessages : IsNever<ContextMessages> extends false ? ContextMessages : never, Message = string>(context: Context, key: Key | ResourceKeys | number | MessageFunction<Message>, plural: number): MessageFunctionReturn<Message> | number;
  883. export declare function translate<Context extends CoreContext<Message, {}, {}, {}>, Key extends string = string, DefinedLocaleMessage extends RemovedIndexResources<DefineCoreLocaleMessage> = RemovedIndexResources<DefineCoreLocaleMessage>, CoreMessages = IsEmptyObject<DefinedLocaleMessage> extends false ? PickupPaths<{
  884. [K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K];
  885. }> : never, ContextMessages = IsEmptyObject<Context['messages']> extends false ? PickupKeys<Context['messages']> : never, ResourceKeys extends CoreMessages | ContextMessages = IsNever<CoreMessages> extends false ? IsNever<ContextMessages> extends false ? CoreMessages | ContextMessages : CoreMessages : IsNever<ContextMessages> extends false ? ContextMessages : never, Message = string>(context: Context, key: Key | ResourceKeys | number | MessageFunction<Message>): MessageFunctionReturn<Message> | number;
  886. export declare function translate<Context extends CoreContext<Message, {}, {}, {}>, Key extends string = string, DefinedLocaleMessage extends RemovedIndexResources<DefineCoreLocaleMessage> = RemovedIndexResources<DefineCoreLocaleMessage>, CoreMessages = IsEmptyObject<DefinedLocaleMessage> extends false ? PickupPaths<{
  887. [K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K];
  888. }> : never, ContextMessages = IsEmptyObject<Context['messages']> extends false ? PickupKeys<Context['messages']> : never, ResourceKeys extends CoreMessages | ContextMessages = IsNever<CoreMessages> extends false ? IsNever<ContextMessages> extends false ? CoreMessages | ContextMessages : CoreMessages : IsNever<ContextMessages> extends false ? ContextMessages : never, Message = string>(context: Context, key: Key | ResourceKeys | number | MessageFunction<Message>, plural: number): MessageFunctionReturn<Message> | number;
  889. export declare function translate<Context extends CoreContext<Message, {}, {}, {}>, Key extends string = string, DefinedLocaleMessage extends RemovedIndexResources<DefineCoreLocaleMessage> = RemovedIndexResources<DefineCoreLocaleMessage>, CoreMessages = IsEmptyObject<DefinedLocaleMessage> extends false ? PickupPaths<{
  890. [K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K];
  891. }> : never, ContextMessages = IsEmptyObject<Context['messages']> extends false ? PickupKeys<Context['messages']> : never, ResourceKeys extends CoreMessages | ContextMessages = IsNever<CoreMessages> extends false ? IsNever<ContextMessages> extends false ? CoreMessages | ContextMessages : CoreMessages : IsNever<ContextMessages> extends false ? ContextMessages : never, Message = string>(context: Context, key: Key | ResourceKeys | number | MessageFunction<Message>, plural: number, options: TranslateOptions<Context['locale']>): MessageFunctionReturn<Message> | number;
  892. export declare function translate<Context extends CoreContext<Message, {}, {}, {}>, Key extends string = string, DefinedLocaleMessage extends RemovedIndexResources<DefineCoreLocaleMessage> = RemovedIndexResources<DefineCoreLocaleMessage>, CoreMessages = IsEmptyObject<DefinedLocaleMessage> extends false ? PickupPaths<{
  893. [K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K];
  894. }> : never, ContextMessages = IsEmptyObject<Context['messages']> extends false ? PickupKeys<Context['messages']> : never, ResourceKeys extends CoreMessages | ContextMessages = IsNever<CoreMessages> extends false ? IsNever<ContextMessages> extends false ? CoreMessages | ContextMessages : CoreMessages : IsNever<ContextMessages> extends false ? ContextMessages : never, Message = string>(context: Context, key: Key | ResourceKeys | number | MessageFunction<Message>, defaultMsg: string): MessageFunctionReturn<Message> | number;
  895. export declare function translate<Context extends CoreContext<Message, {}, {}, {}>, Key extends string = string, DefinedLocaleMessage extends RemovedIndexResources<DefineCoreLocaleMessage> = RemovedIndexResources<DefineCoreLocaleMessage>, CoreMessages = IsEmptyObject<DefinedLocaleMessage> extends false ? PickupPaths<{
  896. [K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K];
  897. }> : never, ContextMessages = IsEmptyObject<Context['messages']> extends false ? PickupKeys<Context['messages']> : never, ResourceKeys extends CoreMessages | ContextMessages = IsNever<CoreMessages> extends false ? IsNever<ContextMessages> extends false ? CoreMessages | ContextMessages : CoreMessages : IsNever<ContextMessages> extends false ? ContextMessages : never, Message = string>(context: Context, key: Key | ResourceKeys | number | MessageFunction<Message>, defaultMsg: string, options: TranslateOptions<Context['locale']>): MessageFunctionReturn<Message> | number;
  898. export declare function translate<Context extends CoreContext<Message, {}, {}, {}>, Key extends string = string, DefinedLocaleMessage extends RemovedIndexResources<DefineCoreLocaleMessage> = RemovedIndexResources<DefineCoreLocaleMessage>, CoreMessages = IsEmptyObject<DefinedLocaleMessage> extends false ? PickupPaths<{
  899. [K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K];
  900. }> : never, ContextMessages = IsEmptyObject<Context['messages']> extends false ? PickupKeys<Context['messages']> : never, ResourceKeys extends CoreMessages | ContextMessages = IsNever<CoreMessages> extends false ? IsNever<ContextMessages> extends false ? CoreMessages | ContextMessages : CoreMessages : IsNever<ContextMessages> extends false ? ContextMessages : never, Message = string>(context: Context, key: Key | ResourceKeys | number | MessageFunction<Message>, list: unknown[]): MessageFunctionReturn<Message> | number;
  901. export declare function translate<Context extends CoreContext<Message, {}, {}, {}>, Key extends string = string, DefinedLocaleMessage extends RemovedIndexResources<DefineCoreLocaleMessage> = RemovedIndexResources<DefineCoreLocaleMessage>, CoreMessages = IsEmptyObject<DefinedLocaleMessage> extends false ? PickupPaths<{
  902. [K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K];
  903. }> : never, ContextMessages = IsEmptyObject<Context['messages']> extends false ? PickupKeys<Context['messages']> : never, ResourceKeys extends CoreMessages | ContextMessages = IsNever<CoreMessages> extends false ? IsNever<ContextMessages> extends false ? CoreMessages | ContextMessages : CoreMessages : IsNever<ContextMessages> extends false ? ContextMessages : never, Message = string>(context: Context, key: Key | ResourceKeys | number | MessageFunction<Message>, list: unknown[], plural: number): MessageFunctionReturn<Message> | number;
  904. export declare function translate<Context extends CoreContext<Message, {}, {}, {}>, Key extends string = string, DefinedLocaleMessage extends RemovedIndexResources<DefineCoreLocaleMessage> = RemovedIndexResources<DefineCoreLocaleMessage>, CoreMessages = IsEmptyObject<DefinedLocaleMessage> extends false ? PickupPaths<{
  905. [K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K];
  906. }> : never, ContextMessages = IsEmptyObject<Context['messages']> extends false ? PickupKeys<Context['messages']> : never, ResourceKeys extends CoreMessages | ContextMessages = IsNever<CoreMessages> extends false ? IsNever<ContextMessages> extends false ? CoreMessages | ContextMessages : CoreMessages : IsNever<ContextMessages> extends false ? ContextMessages : never, Message = string>(context: Context, key: Key | ResourceKeys | number | MessageFunction<Message>, list: unknown[], defaultMsg: string): MessageFunctionReturn<Message> | number;
  907. export declare function translate<Context extends CoreContext<Message, {}, {}, {}>, Key extends string = string, DefinedLocaleMessage extends RemovedIndexResources<DefineCoreLocaleMessage> = RemovedIndexResources<DefineCoreLocaleMessage>, CoreMessages = IsEmptyObject<DefinedLocaleMessage> extends false ? PickupPaths<{
  908. [K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K];
  909. }> : never, ContextMessages = IsEmptyObject<Context['messages']> extends false ? PickupKeys<Context['messages']> : never, ResourceKeys extends CoreMessages | ContextMessages = IsNever<CoreMessages> extends false ? IsNever<ContextMessages> extends false ? CoreMessages | ContextMessages : CoreMessages : IsNever<ContextMessages> extends false ? ContextMessages : never, Message = string>(context: Context, key: Key | ResourceKeys | number | MessageFunction<Message>, list: unknown[], options: TranslateOptions<Context['locale']>): MessageFunctionReturn<Message> | number;
  910. export declare function translate<Context extends CoreContext<Message, {}, {}, {}>, Key extends string = string, DefinedLocaleMessage extends RemovedIndexResources<DefineCoreLocaleMessage> = RemovedIndexResources<DefineCoreLocaleMessage>, CoreMessages = IsEmptyObject<DefinedLocaleMessage> extends false ? PickupPaths<{
  911. [K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K];
  912. }> : never, ContextMessages = IsEmptyObject<Context['messages']> extends false ? PickupKeys<Context['messages']> : never, ResourceKeys extends CoreMessages | ContextMessages = IsNever<CoreMessages> extends false ? IsNever<ContextMessages> extends false ? CoreMessages | ContextMessages : CoreMessages : IsNever<ContextMessages> extends false ? ContextMessages : never, Message = string>(context: Context, key: Key | ResourceKeys | number | MessageFunction<Message>, named: NamedValue): MessageFunctionReturn<Message> | number;
  913. export declare function translate<Context extends CoreContext<Message, {}, {}, {}>, Key extends string = string, DefinedLocaleMessage extends RemovedIndexResources<DefineCoreLocaleMessage> = RemovedIndexResources<DefineCoreLocaleMessage>, CoreMessages = IsEmptyObject<DefinedLocaleMessage> extends false ? PickupPaths<{
  914. [K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K];
  915. }> : never, ContextMessages = IsEmptyObject<Context['messages']> extends false ? PickupKeys<Context['messages']> : never, ResourceKeys extends CoreMessages | ContextMessages = IsNever<CoreMessages> extends false ? IsNever<ContextMessages> extends false ? CoreMessages | ContextMessages : CoreMessages : IsNever<ContextMessages> extends false ? ContextMessages : never, Message = string>(context: Context, key: Key | ResourceKeys | number | MessageFunction<Message>, named: NamedValue, plural: number): MessageFunctionReturn<Message> | number;
  916. export declare function translate<Context extends CoreContext<Message, {}, {}, {}>, Key extends string = string, DefinedLocaleMessage extends RemovedIndexResources<DefineCoreLocaleMessage> = RemovedIndexResources<DefineCoreLocaleMessage>, CoreMessages = IsEmptyObject<DefinedLocaleMessage> extends false ? PickupPaths<{
  917. [K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K];
  918. }> : never, ContextMessages = IsEmptyObject<Context['messages']> extends false ? PickupKeys<Context['messages']> : never, ResourceKeys extends CoreMessages | ContextMessages = IsNever<CoreMessages> extends false ? IsNever<ContextMessages> extends false ? CoreMessages | ContextMessages : CoreMessages : IsNever<ContextMessages> extends false ? ContextMessages : never, Message = string>(context: Context, key: Key | ResourceKeys | number | MessageFunction<Message>, named: NamedValue, defaultMsg: string): MessageFunctionReturn<Message> | number;
  919. export declare function translate<Context extends CoreContext<Message, {}, {}, {}>, Key extends string = string, DefinedLocaleMessage extends RemovedIndexResources<DefineCoreLocaleMessage> = RemovedIndexResources<DefineCoreLocaleMessage>, CoreMessages = IsEmptyObject<DefinedLocaleMessage> extends false ? PickupPaths<{
  920. [K in keyof DefinedLocaleMessage]: DefinedLocaleMessage[K];
  921. }> : never, ContextMessages = IsEmptyObject<Context['messages']> extends false ? PickupKeys<Context['messages']> : never, ResourceKeys extends CoreMessages | ContextMessages = IsNever<CoreMessages> extends false ? IsNever<ContextMessages> extends false ? CoreMessages | ContextMessages : CoreMessages : IsNever<ContextMessages> extends false ? ContextMessages : never, Message = string>(context: Context, key: Key | ResourceKeys | number | MessageFunction<Message>, named: NamedValue, options: TranslateOptions<Context['locale']>): MessageFunctionReturn<Message> | number;
  922. export declare const translateDevTools: (payloads: IntlifyDevToolsHookPayloads[IntlifyDevToolsHooks]) => void | null;
  923. /**
  924. * # translate
  925. *
  926. * ## usages:
  927. * // for example, locale messages key
  928. * { 'foo.bar': 'hi {0} !' or 'hi {name} !' }
  929. *
  930. * // no argument, context & path only
  931. * translate(context, 'foo.bar')
  932. *
  933. * // list argument
  934. * translate(context, 'foo.bar', ['kazupon'])
  935. *
  936. * // named argument
  937. * translate(context, 'foo.bar', { name: 'kazupon' })
  938. *
  939. * // plural choice number
  940. * translate(context, 'foo.bar', 2)
  941. *
  942. * // plural choice number with name argument
  943. * translate(context, 'foo.bar', { name: 'kazupon' }, 2)
  944. *
  945. * // default message argument
  946. * translate(context, 'foo.bar', 'this is default message')
  947. *
  948. * // default message with named argument
  949. * translate(context, 'foo.bar', { name: 'kazupon' }, 'Hello {name} !')
  950. *
  951. * // use key as default message
  952. * translate(context, 'hi {0} !', ['kazupon'], { default: true })
  953. *
  954. * // locale option, override context.locale
  955. * translate(context, 'foo.bar', { name: 'kazupon' }, { locale: 'ja' })
  956. *
  957. * // suppress localize miss warning option, override context.missingWarn
  958. * translate(context, 'foo.bar', { name: 'kazupon' }, { missingWarn: false })
  959. *
  960. * // suppress localize fallback warning option, override context.fallbackWarn
  961. * translate(context, 'foo.bar', { name: 'kazupon' }, { fallbackWarn: false })
  962. *
  963. * // escape parameter option, override context.escapeParameter
  964. * translate(context, 'foo.bar', { name: 'kazupon' }, { escapeParameter: true })
  965. */
  966. /**
  967. * Translate Options
  968. *
  969. * @remarks
  970. * Options for Translation API
  971. *
  972. * @VueI18nGeneral
  973. */
  974. export declare interface TranslateOptions<Locales = Locale> extends LocaleOptions<Locales> {
  975. /**
  976. * @remarks
  977. * List interpolation
  978. */
  979. list?: unknown[];
  980. /**
  981. * @remarks
  982. * Named interpolation
  983. */
  984. named?: NamedValue;
  985. /**
  986. * @remarks
  987. * Plulralzation choice number
  988. */
  989. plural?: number;
  990. /**
  991. * @remarks
  992. * Default message when is occurred translation missing
  993. */
  994. default?: string | boolean;
  995. /**
  996. * @remarks
  997. * Whether suppress warnings outputted when localization fails
  998. */
  999. missingWarn?: boolean;
  1000. /**
  1001. * @remarks
  1002. * Whether do template interpolation on translation keys when your language lacks a translation for a key
  1003. */
  1004. fallbackWarn?: boolean;
  1005. /**
  1006. * @remarks
  1007. * Whether do escape parameter for list or named interpolation values
  1008. */
  1009. escapeParameter?: boolean;
  1010. /**
  1011. * @remarks
  1012. * Whether the message has been resolved
  1013. */
  1014. resolvedMessage?: boolean;
  1015. }
  1016. export declare type UnionToIntersection<U> = (U extends any ? (arg: U) => void : never) extends (arg: infer I) => void ? I : never;
  1017. export declare type UnionToTuple<U, Last = LastInUnion<U>> = [U] extends [never] ? [] : [...UnionToTuple<Exclude<U, Last>>, Last];
  1018. /* Excluded from this release type: updateFallbackLocale */
  1019. /* Excluded from this release type: VERSION */
  1020. declare type VueDevToolsEmitter = Emittable<VueDevToolsEmitterEvents>;
  1021. declare type VueDevToolsEmitterEvents = {
  1022. [VueDevToolsTimelineEvents.COMPILE_ERROR]: VueDevToolsTimelineEventPayloads[VueDevToolsTimelineEvents.COMPILE_ERROR];
  1023. [VueDevToolsTimelineEvents.MISSING]: VueDevToolsTimelineEventPayloads[VueDevToolsTimelineEvents.MISSING];
  1024. [VueDevToolsTimelineEvents.FALBACK]: VueDevToolsTimelineEventPayloads[VueDevToolsTimelineEvents.FALBACK];
  1025. [VueDevToolsTimelineEvents.MESSAGE_RESOLVE]: VueDevToolsTimelineEventPayloads[VueDevToolsTimelineEvents.MESSAGE_RESOLVE];
  1026. [VueDevToolsTimelineEvents.MESSAGE_COMPILATION]: VueDevToolsTimelineEventPayloads[VueDevToolsTimelineEvents.MESSAGE_COMPILATION];
  1027. [VueDevToolsTimelineEvents.MESSAGE_EVALUATION]: VueDevToolsTimelineEventPayloads[VueDevToolsTimelineEvents.MESSAGE_EVALUATION];
  1028. };
  1029. declare type VueDevToolsTimelineEventPayloads = {
  1030. [VueDevToolsTimelineEvents.COMPILE_ERROR]: {
  1031. message: string;
  1032. error: string;
  1033. start?: number;
  1034. end?: number;
  1035. groupId?: string;
  1036. };
  1037. [VueDevToolsTimelineEvents.MISSING]: {
  1038. locale: Locale_2;
  1039. key: Path_2;
  1040. type: CoreMissingType_2;
  1041. groupId?: string;
  1042. };
  1043. [VueDevToolsTimelineEvents.FALBACK]: {
  1044. key: Path_2;
  1045. type: CoreMissingType_2;
  1046. from?: Locale_2;
  1047. to: Locale_2 | 'global';
  1048. groupId?: string;
  1049. };
  1050. [VueDevToolsTimelineEvents.MESSAGE_RESOLVE]: {
  1051. type: VueDevToolsTimelineEvents.MESSAGE_RESOLVE;
  1052. key: Path_2;
  1053. message: PathValue_2;
  1054. time: number;
  1055. groupId?: string;
  1056. };
  1057. [VueDevToolsTimelineEvents.MESSAGE_COMPILATION]: {
  1058. type: VueDevToolsTimelineEvents.MESSAGE_COMPILATION;
  1059. message: string | ResourceNode_2 | MessageFunction_2;
  1060. time: number;
  1061. groupId?: string;
  1062. };
  1063. [VueDevToolsTimelineEvents.MESSAGE_EVALUATION]: {
  1064. type: VueDevToolsTimelineEvents.MESSAGE_EVALUATION;
  1065. value: unknown;
  1066. time: number;
  1067. groupId?: string;
  1068. };
  1069. };
  1070. declare const enum VueDevToolsTimelineEvents {
  1071. COMPILE_ERROR = "compile-error",
  1072. MISSING = "missing",
  1073. FALBACK = "fallback",
  1074. MESSAGE_RESOLVE = "message-resolve",
  1075. MESSAGE_COMPILATION = "message-compilation",
  1076. MESSAGE_EVALUATION = "message-evaluation"
  1077. }
  1078. export { }