Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ yarn add vue-i18n@next
- [x] number function
- [x] warnHtmlMessage
- [x] improve translate `args` typing
- [ ] improve locale messages typing: `LocaleMessages` / `LocaleMessage` / `LocaleMessageDictiory`
- [x] improve locale messages typing: `LocaleMessages` / `LocaleMessage` / `LocaleMessageDictiory`
- [x] postTranslation context option
- Composable API: I18n Composer
- properties
Expand Down
11 changes: 0 additions & 11 deletions docs/vue-i18n.availabilities.md

This file was deleted.

11 changes: 11 additions & 0 deletions docs/vue-i18n.baseformatprops.locale.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [vue-i18n](./vue-i18n.md) &gt; [BaseFormatProps](./vue-i18n.baseformatprops.md) &gt; [locale](./vue-i18n.baseformatprops.locale.md)

## BaseFormatProps.locale property

<b>Signature:</b>

```typescript
locale?: Locale;
```
20 changes: 20 additions & 0 deletions docs/vue-i18n.baseformatprops.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [vue-i18n](./vue-i18n.md) &gt; [BaseFormatProps](./vue-i18n.baseformatprops.md)

## BaseFormatProps interface

<b>Signature:</b>

```typescript
export interface BaseFormatProps
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [locale](./vue-i18n.baseformatprops.locale.md) | <code>Locale</code> | |
| [scope](./vue-i18n.baseformatprops.scope.md) | <code>ComponetI18nScope</code> | |
| [tag](./vue-i18n.baseformatprops.tag.md) | <code>string</code> | |

11 changes: 11 additions & 0 deletions docs/vue-i18n.baseformatprops.scope.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [vue-i18n](./vue-i18n.md) &gt; [BaseFormatProps](./vue-i18n.baseformatprops.md) &gt; [scope](./vue-i18n.baseformatprops.scope.md)

## BaseFormatProps.scope property

<b>Signature:</b>

```typescript
scope?: ComponetI18nScope;
```
11 changes: 11 additions & 0 deletions docs/vue-i18n.baseformatprops.tag.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [vue-i18n](./vue-i18n.md) &gt; [BaseFormatProps](./vue-i18n.baseformatprops.md) &gt; [tag](./vue-i18n.baseformatprops.tag.md)

## BaseFormatProps.tag property

<b>Signature:</b>

```typescript
tag?: string;
```
15 changes: 15 additions & 0 deletions docs/vue-i18n.clearcompilecache.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [vue-i18n](./vue-i18n.md) &gt; [clearCompileCache](./vue-i18n.clearcompilecache.md)

## clearCompileCache() function

<b>Signature:</b>

```typescript
export declare function clearCompileCache(): void;
```
<b>Returns:</b>

`void`

24 changes: 24 additions & 0 deletions docs/vue-i18n.cleardatetimeformat.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [vue-i18n](./vue-i18n.md) &gt; [clearDateTimeFormat](./vue-i18n.cleardatetimeformat.md)

## clearDateTimeFormat() function

<b>Signature:</b>

```typescript
export declare function clearDateTimeFormat<DateTimeFormats = {}, Message = string>(ctx: RuntimeDateTimeContext<DateTimeFormats, Message>, locale: Locale, format: DateTimeFormat): void;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| ctx | <code>RuntimeDateTimeContext&lt;DateTimeFormats, Message&gt;</code> | |
| locale | <code>Locale</code> | |
| format | <code>DateTimeFormat</code> | |

<b>Returns:</b>

`void`

24 changes: 24 additions & 0 deletions docs/vue-i18n.clearnumberformat.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [vue-i18n](./vue-i18n.md) &gt; [clearNumberFormat](./vue-i18n.clearnumberformat.md)

## clearNumberFormat() function

<b>Signature:</b>

```typescript
export declare function clearNumberFormat<NumberFormats, Message = string>(ctx: RuntimeNumberContext<NumberFormats, Message>, locale: Locale, format: NumberFormat): void;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| ctx | <code>RuntimeNumberContext&lt;NumberFormats, Message&gt;</code> | |
| locale | <code>Locale</code> | |
| format | <code>NumberFormat</code> | |

<b>Returns:</b>

`void`

4 changes: 2 additions & 2 deletions docs/vue-i18n.compile.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<b>Signature:</b>

```typescript
export declare function compile(source: string, options?: CompileOptions): MessageFunction;
export declare function compile<T = string>(source: string, options?: CompileOptions): MessageFunction<T>;
```

## Parameters
Expand All @@ -19,5 +19,5 @@ export declare function compile(source: string, options?: CompileOptions): Messa

<b>Returns:</b>

`MessageFunction`
`MessageFunction<T>`

2 changes: 1 addition & 1 deletion docs/vue-i18n.compileerror.code.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@
<b>Signature:</b>

```typescript
code: CompileErrorCodes;
code: number;
```
2 changes: 1 addition & 1 deletion docs/vue-i18n.compileerror.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ export interface CompileError extends SyntaxError

| Property | Type | Description |
| --- | --- | --- |
| [code](./vue-i18n.compileerror.code.md) | <code>CompileErrorCodes</code> | |
| [code](./vue-i18n.compileerror.code.md) | <code>number</code> | |
| [domain](./vue-i18n.compileerror.domain.md) | <code>CompileDomain</code> | |
| [location](./vue-i18n.compileerror.location.md) | <code>SourceLocation</code> | |

3 changes: 2 additions & 1 deletion docs/vue-i18n.compileerrorcodes.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ export declare const enum CompileErrorCodes

| Member | Value | Description |
| --- | --- | --- |
| \_\_EXTEND\_POINT\_\_ | <code>11</code> | |
| \_\_EXTEND\_POINT\_\_ | <code>12</code> | |
| EMPTY\_PLACEHOLDER | <code>7</code> | |
| EXPECTED\_TOKEN | <code>0</code> | |
| INVALID\_LINKED\_FORMAT | <code>9</code> | |
Expand All @@ -23,6 +23,7 @@ export declare const enum CompileErrorCodes
| MUST\_HAVE\_MESSAGES\_IN\_PLURAL | <code>10</code> | |
| NOT\_ALLOW\_NEST\_PLACEHOLDER | <code>8</code> | |
| UNBALANCED\_CLOSING\_BRACE | <code>5</code> | |
| UNEXPECTED\_LEXICAL\_ANALYSIS | <code>11</code> | |
| UNKNOWN\_ESCAPE\_SEQUENCE | <code>3</code> | |
| UNTERMINATED\_CLOSING\_BRACE | <code>6</code> | |
| UNTERMINATED\_SINGLE\_QUOTE\_IN\_PLACEHOLDER | <code>2</code> | |
Expand Down
11 changes: 11 additions & 0 deletions docs/vue-i18n.componeti18nscope.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [vue-i18n](./vue-i18n.md) &gt; [ComponetI18nScope](./vue-i18n.componeti18nscope.md)

## ComponetI18nScope type

<b>Signature:</b>

```typescript
export declare type ComponetI18nScope = Exclude<I18nScope, 'local'>;
```
4 changes: 2 additions & 2 deletions docs/vue-i18n.composer.getlocalemessage.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<b>Signature:</b>

```typescript
getLocaleMessage(locale: Locale): LocaleMessage;
getLocaleMessage(locale: Locale): LocaleMessageDictionary<Message>;
```

## Parameters
Expand All @@ -18,5 +18,5 @@ getLocaleMessage(locale: Locale): LocaleMessage;

<b>Returns:</b>

`LocaleMessage`
`LocaleMessageDictionary<Message>`

4 changes: 2 additions & 2 deletions docs/vue-i18n.composer.getposttranslationhandler.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
<b>Signature:</b>

```typescript
getPostTranslationHandler(): PostTranslationHandler | null;
getPostTranslationHandler(): PostTranslationHandler<Message> | null;
```
<b>Returns:</b>

`PostTranslationHandler | null`
`PostTranslationHandler<Message> | null`

6 changes: 3 additions & 3 deletions docs/vue-i18n.composer.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Composer Interfaces
<b>Signature:</b>

```typescript
export interface Composer
export interface Composer<Messages = {}, DateTimeFormats = {}, NumberFormats = {}, Message = VueMessageType>
```

## Remarks
Expand All @@ -29,9 +29,9 @@ This is the interface for being used for Vue 3 Composition API.
| [inheritLocale](./vue-i18n.composer.inheritlocale.md) | <code>boolean</code> | |
| [isGlobal](./vue-i18n.composer.isglobal.md) | <code>boolean</code> | |
| [locale](./vue-i18n.composer.locale.md) | <code>WritableComputedRef&lt;Locale&gt;</code> | |
| [messages](./vue-i18n.composer.messages.md) | <code>ComputedRef&lt;LocaleMessages&gt;</code> | |
| [messages](./vue-i18n.composer.messages.md) | <code>ComputedRef&lt;Messages&gt;</code> | |
| [missingWarn](./vue-i18n.composer.missingwarn.md) | <code>boolean &#124; RegExp</code> | |
| [modifiers](./vue-i18n.composer.modifiers.md) | <code>LinkedModifiers</code> | |
| [modifiers](./vue-i18n.composer.modifiers.md) | <code>LinkedModifiers&lt;Message&gt;</code> | |
| [numberFormats](./vue-i18n.composer.numberformats.md) | <code>ComputedRef&lt;NumberFormats&gt;</code> | |
| [pluralRules](./vue-i18n.composer.pluralrules.md) | <code>PluralizationRules</code> | |
| [warnHtmlMessage](./vue-i18n.composer.warnhtmlmessage.md) | <code>boolean</code> | |
Expand Down
4 changes: 2 additions & 2 deletions docs/vue-i18n.composer.mergelocalemessage.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@
<b>Signature:</b>

```typescript
mergeLocaleMessage(locale: Locale, message: LocaleMessage): void;
mergeLocaleMessage(locale: Locale, message: LocaleMessageDictionary<Message>): void;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| locale | <code>Locale</code> | |
| message | <code>LocaleMessage</code> | |
| message | <code>LocaleMessageDictionary&lt;Message&gt;</code> | |

<b>Returns:</b>

Expand Down
2 changes: 1 addition & 1 deletion docs/vue-i18n.composer.messages.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@
<b>Signature:</b>

```typescript
readonly messages: ComputedRef<LocaleMessages>;
readonly messages: ComputedRef<Messages>;
```
2 changes: 1 addition & 1 deletion docs/vue-i18n.composer.modifiers.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@
<b>Signature:</b>

```typescript
readonly modifiers: LinkedModifiers;
readonly modifiers: LinkedModifiers<Message>;
```
4 changes: 2 additions & 2 deletions docs/vue-i18n.composer.setlocalemessage.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@
<b>Signature:</b>

```typescript
setLocaleMessage(locale: Locale, message: LocaleMessage): void;
setLocaleMessage(locale: Locale, message: LocaleMessageDictionary<Message>): void;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| locale | <code>Locale</code> | |
| message | <code>LocaleMessage</code> | |
| message | <code>LocaleMessageDictionary&lt;Message&gt;</code> | |

<b>Returns:</b>

Expand Down
4 changes: 2 additions & 2 deletions docs/vue-i18n.composer.setposttranslationhandler.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@
<b>Signature:</b>

```typescript
setPostTranslationHandler(handler: PostTranslationHandler | null): void;
setPostTranslationHandler(handler: PostTranslationHandler<Message> | null): void;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| handler | <code>PostTranslationHandler &#124; null</code> | |
| handler | <code>PostTranslationHandler&lt;Message&gt; &#124; null</code> | |

<b>Returns:</b>

Expand Down
2 changes: 1 addition & 1 deletion docs/vue-i18n.composeroptions.datetimeformats.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@
<b>Signature:</b>

```typescript
datetimeFormats?: DateTimeFormats;
datetimeFormats?: DateTimeFormatsType;
```
12 changes: 6 additions & 6 deletions docs/vue-i18n.composeroptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Composer Options
<b>Signature:</b>

```typescript
export interface ComposerOptions
export interface ComposerOptions<Message = VueMessageType>
```

## Remarks
Expand All @@ -20,19 +20,19 @@ This is options to create composer.

| Property | Type | Description |
| --- | --- | --- |
| [datetimeFormats](./vue-i18n.composeroptions.datetimeformats.md) | <code>DateTimeFormats</code> | |
| [datetimeFormats](./vue-i18n.composeroptions.datetimeformats.md) | <code>DateTimeFormatsType</code> | |
| [fallbackFormat](./vue-i18n.composeroptions.fallbackformat.md) | <code>boolean</code> | |
| [fallbackLocale](./vue-i18n.composeroptions.fallbacklocale.md) | <code>FallbackLocale</code> | |
| [fallbackRoot](./vue-i18n.composeroptions.fallbackroot.md) | <code>boolean</code> | |
| [fallbackWarn](./vue-i18n.composeroptions.fallbackwarn.md) | <code>boolean &#124; RegExp</code> | |
| [inheritLocale](./vue-i18n.composeroptions.inheritlocale.md) | <code>boolean</code> | |
| [locale](./vue-i18n.composeroptions.locale.md) | <code>Locale</code> | |
| [messages](./vue-i18n.composeroptions.messages.md) | <code>LocaleMessages</code> | |
| [messages](./vue-i18n.composeroptions.messages.md) | <code>LocaleMessages&lt;Message&gt;</code> | |
| [missing](./vue-i18n.composeroptions.missing.md) | <code>MissingHandler</code> | |
| [missingWarn](./vue-i18n.composeroptions.missingwarn.md) | <code>boolean &#124; RegExp</code> | |
| [modifiers](./vue-i18n.composeroptions.modifiers.md) | <code>LinkedModifiers</code> | |
| [numberFormats](./vue-i18n.composeroptions.numberformats.md) | <code>NumberFormats</code> | |
| [modifiers](./vue-i18n.composeroptions.modifiers.md) | <code>LinkedModifiers&lt;Message&gt;</code> | |
| [numberFormats](./vue-i18n.composeroptions.numberformats.md) | <code>NumberFormatsType</code> | |
| [pluralRules](./vue-i18n.composeroptions.pluralrules.md) | <code>PluralizationRules</code> | |
| [postTranslation](./vue-i18n.composeroptions.posttranslation.md) | <code>PostTranslationHandler</code> | |
| [postTranslation](./vue-i18n.composeroptions.posttranslation.md) | <code>PostTranslationHandler&lt;Message&gt;</code> | |
| [warnHtmlMessage](./vue-i18n.composeroptions.warnhtmlmessage.md) | <code>boolean</code> | |

2 changes: 1 addition & 1 deletion docs/vue-i18n.composeroptions.messages.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@
<b>Signature:</b>

```typescript
messages?: LocaleMessages;
messages?: LocaleMessages<Message>;
```
2 changes: 1 addition & 1 deletion docs/vue-i18n.composeroptions.modifiers.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@
<b>Signature:</b>

```typescript
modifiers?: LinkedModifiers;
modifiers?: LinkedModifiers<Message>;
```
2 changes: 1 addition & 1 deletion docs/vue-i18n.composeroptions.numberformats.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@
<b>Signature:</b>

```typescript
numberFormats?: NumberFormats;
numberFormats?: NumberFormatsType;
```
2 changes: 1 addition & 1 deletion docs/vue-i18n.composeroptions.posttranslation.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@
<b>Signature:</b>

```typescript
postTranslation?: PostTranslationHandler;
postTranslation?: PostTranslationHandler<Message>;
```
Loading