update docs

intlify · May 8, 2020 · 26c3fb7 · 26c3fb7
1 parent cd5492c
commit 26c3fb7
Show file tree

Hide file tree

Showing 19 changed files with 109 additions and 88 deletions.
diff --git a/docs/vue-i18n.composer.md b/docs/vue-i18n.composer.md
@@ -6,8 +6,6 @@
 
 Composer Interfaces
 
-This is the interface for being used for Vue 3 Composition API.
-
 <b>Signature:</b>
 
 ```typescript
@@ -76,3 +74,8 @@ export declare type Composer = {
     __datetimeParts(...args: unknown[]): string | Intl.DateTimeFormatPart[];
 };
 ```
+
+## Remarks
+
+This is the interface for being used for Vue 3 Composition API.
+
diff --git a/docs/vue-i18n.composeradditionaloptions.md b/docs/vue-i18n.composeradditionaloptions.md
@@ -4,7 +4,7 @@
 
 ## ComposerAdditionalOptions interface
 
-Composer additional options
+Composer additional options for `useI18n`
 
 <b>Signature:</b>
 

diff --git a/docs/vue-i18n.composeroptions.md b/docs/vue-i18n.composeroptions.md
@@ -6,14 +6,16 @@
 
 Composer Options
 
-This is options to create composer.
-
 <b>Signature:</b>
 
 ```typescript
 export interface ComposerOptions 
 ```
 
+## Remarks
+
+This is options to create composer.
+
 ## Properties
 
 |  Property | Type | Description |

diff --git a/docs/vue-i18n.createi18n.md b/docs/vue-i18n.createi18n.md
@@ -26,7 +26,7 @@ export declare function createI18n(options?: I18nOptions): I18n;
 
 ## Remarks
 
-When you use Composable API, you need to specify options of [ComposerOptions](./vue-i18n.composeroptions.md)<!-- -->. When you use Legacy API, you need toto specify options of [VueI18nOptions](./vue-i18n.vuei18noptions.md) and `legacy: true`<!-- -->.
+When you use Composable API, you need to specify options of [ComposerOptions](./vue-i18n.composeroptions.md)<!-- -->. When you use Legacy API, you need toto specify options of [VueI18nOptions](./vue-i18n.vuei18noptions.md) and `legacy: true` option.
 
 ## Example 1
 

diff --git a/docs/vue-i18n.i18n.global.md b/docs/vue-i18n.i18n.global.md
@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [vue-i18n](./vue-i18n.md) &gt; [I18n](./vue-i18n.i18n.md) &gt; [global](./vue-i18n.i18n.global.md)
+
+## I18n.global property
+
+Global composer
+
+<b>Signature:</b>
+
+```typescript
+readonly global: Composer;
+```
diff --git a/docs/vue-i18n.i18n.install.md b/docs/vue-i18n.i18n.install.md
diff --git a/docs/vue-i18n.i18n.md b/docs/vue-i18n.i18n.md
@@ -16,11 +16,6 @@ export interface I18n
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [mode](./vue-i18n.i18n.mode.md) | <code>I18nMode</code> |  |
-
-## Methods
-
-|  Method | Description |
-|  --- | --- |
-|  [install(app, options)](./vue-i18n.i18n.install.md) |  |
+|  [global](./vue-i18n.i18n.global.md) | <code>Composer</code> | Global composer |
+|  [mode](./vue-i18n.i18n.mode.md) | <code>I18nMode</code> | I18n API mode |
 
diff --git a/docs/vue-i18n.i18n.mode.md b/docs/vue-i18n.i18n.mode.md
@@ -4,8 +4,15 @@
 
 ## I18n.mode property
 
+I18n API mode
+
 <b>Signature:</b>
 
 ```typescript
 readonly mode: I18nMode;
 ```
+
+## Remarks
+
+if you specified `legacy: true` option in `createI18n`<!-- -->, return `legacy`<!-- -->, else `composable`
+
diff --git a/docs/vue-i18n.i18nadditionaloptions.legacy.md b/docs/vue-i18n.i18nadditionaloptions.legacy.md
@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [vue-i18n](./vue-i18n.md) &gt; [I18nAdditionalOptions](./vue-i18n.i18nadditionaloptions.md) &gt; [legacy](./vue-i18n.i18nadditionaloptions.legacy.md)
+
+## I18nAdditionalOptions.legacy property
+
+Whether vue-i18n legacy API use on your Vue App.
+
+<b>Signature:</b>
+
+```typescript
+legacy?: boolean;
+```
diff --git a/docs/vue-i18n.i18nadditionaloptions.md b/docs/vue-i18n.i18nadditionaloptions.md
@@ -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; [I18nAdditionalOptions](./vue-i18n.i18nadditionaloptions.md)
+
+## I18nAdditionalOptions interface
+
+I18n Additional Options for `createI18n`
+
+<b>Signature:</b>
+
+```typescript
+export interface I18nAdditionalOptions 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [legacy](./vue-i18n.i18nadditionaloptions.legacy.md) | <code>boolean</code> | Whether vue-i18n legacy API use on your Vue App. |
+
diff --git a/docs/vue-i18n.i18naddtionaloptions.legacy.md b/docs/vue-i18n.i18naddtionaloptions.legacy.md
diff --git a/docs/vue-i18n.i18naddtionaloptions.md b/docs/vue-i18n.i18naddtionaloptions.md
diff --git a/docs/vue-i18n.i18noptions.md b/docs/vue-i18n.i18noptions.md
@@ -4,8 +4,15 @@
 
 ## I18nOptions type
 
+I18n Options for `createI18n`
+
 <b>Signature:</b>
 
 ```typescript
-export declare type I18nOptions = I18nAddtionalOptions & (ComposerOptions | VueI18nOptions);
+export declare type I18nOptions = I18nAdditionalOptions & (ComposerOptions | VueI18nOptions);
 ```
+
+## Remarks
+
+`I18nOptions` is inherited [I18nAdditionalOptions](./vue-i18n.i18nadditionaloptions.md)<!-- -->, [ComposerOptions](./vue-i18n.composeroptions.md) and [VueI18nOptions](./vue-i18n.vuei18noptions.md)<!-- -->, so you can specify these options.
+
diff --git a/docs/vue-i18n.i18npluginoptions.md b/docs/vue-i18n.i18npluginoptions.md
@@ -4,12 +4,18 @@
 
 ## I18nPluginOptions interface
 
+I18n plugin options
+
 <b>Signature:</b>
 
 ```typescript
 export interface I18nPluginOptions 
 ```
 
+## Remarks
+
+An options specified when installing vue-i18n as Vue plugin with using `app.use`<!-- -->.
+
 ## Properties
 
 |  Property | Type | Description |

diff --git a/docs/vue-i18n.md b/docs/vue-i18n.md
@@ -25,16 +25,16 @@
 |  Interface | Description |
 |  --- | --- |
 |  [CompileError](./vue-i18n.compileerror.md) |  |
-|  [ComposerAdditionalOptions](./vue-i18n.composeradditionaloptions.md) | Composer additional options |
-|  [ComposerOptions](./vue-i18n.composeroptions.md) | Composer Options<!-- -->This is options to create composer. |
+|  [ComposerAdditionalOptions](./vue-i18n.composeradditionaloptions.md) | Composer additional options for <code>useI18n</code> |
+|  [ComposerOptions](./vue-i18n.composeroptions.md) | Composer Options |
 |  [CurrencyNumberFormatOptions](./vue-i18n.currencynumberformatoptions.md) |  |
 |  [Formatter](./vue-i18n.formatter.md) |  |
 |  [I18n](./vue-i18n.i18n.md) | I18n interface |
-|  [I18nAddtionalOptions](./vue-i18n.i18naddtionaloptions.md) | I18n Options |
-|  [I18nPluginOptions](./vue-i18n.i18npluginoptions.md) |  |
+|  [I18nAdditionalOptions](./vue-i18n.i18nadditionaloptions.md) | I18n Additional Options for <code>createI18n</code> |
+|  [I18nPluginOptions](./vue-i18n.i18npluginoptions.md) | I18n plugin options |
 |  [SpecificDateTimeFormatOptions](./vue-i18n.specificdatetimeformatoptions.md) |  |
 |  [SpecificNumberFormatOptions](./vue-i18n.specificnumberformatoptions.md) |  |
-|  [VueI18nOptions](./vue-i18n.vuei18noptions.md) | VueI18n Options<!-- -->This option is compatible with the constructor options of <code>VueI18n</code> class (offered with vue-i18n<!-- -->@<!-- -->8.x). |
+|  [VueI18nOptions](./vue-i18n.vuei18noptions.md) | VueI18n Options |
 
 ## Variables
 
@@ -43,7 +43,7 @@
 |  [Availabilities](./vue-i18n.availabilities.md) |  |
 |  [friendlyJSONstringify](./vue-i18n.friendlyjsonstringify.md) |  |
 |  [generateFormatCacheKey](./vue-i18n.generateformatcachekey.md) |  |
-|  [VERSION](./vue-i18n.version.md) |  |
+|  [VERSION](./vue-i18n.version.md) | vue-i18n version |
 
 ## Type Aliases
 
@@ -53,7 +53,7 @@
 |  [CompileDomain](./vue-i18n.compiledomain.md) |  |
 |  [CompileErrorHandler](./vue-i18n.compileerrorhandler.md) |  |
 |  [CompileOptions](./vue-i18n.compileoptions.md) |  |
-|  [Composer](./vue-i18n.composer.md) | Composer Interfaces<!-- -->This is the interface for being used for Vue 3 Composition API. |
+|  [Composer](./vue-i18n.composer.md) | Composer Interfaces |
 |  [CurrencyDisplay](./vue-i18n.currencydisplay.md) | number |
 |  [DateTimeDigital](./vue-i18n.datetimedigital.md) |  |
 |  [DateTimeFormat](./vue-i18n.datetimeformat.md) |  |
@@ -65,7 +65,7 @@
 |  [FormattedNumberPart](./vue-i18n.formattednumberpart.md) |  |
 |  [FormattedNumberPartType](./vue-i18n.formattednumberparttype.md) |  |
 |  [I18nMode](./vue-i18n.i18nmode.md) | I18n API mode |
-|  [I18nOptions](./vue-i18n.i18noptions.md) |  |
+|  [I18nOptions](./vue-i18n.i18noptions.md) | I18n Options for <code>createI18n</code> |
 |  [I18nScope](./vue-i18n.i18nscope.md) | I18n Scope |
 |  [IntlAvailability](./vue-i18n.intlavailability.md) | datetime |
 |  [LinkedModifiers](./vue-i18n.linkedmodifiers.md) |  |
@@ -89,7 +89,7 @@
 |  [PluralizationRulesMap](./vue-i18n.pluralizationrulesmap.md) |  |
 |  [PostTranslationHandler](./vue-i18n.posttranslationhandler.md) |  |
 |  [TranslateResult](./vue-i18n.translateresult.md) |  |
-|  [UseI18nOptions](./vue-i18n.usei18noptions.md) |  |
-|  [VueI18n](./vue-i18n.vuei18n.md) | VueI18n Interfaces<!-- -->This interface is compatible with interface of <code>VueI18n</code> class (offered with vue-i18n<!-- -->@<!-- -->8.x). |
+|  [UseI18nOptions](./vue-i18n.usei18noptions.md) | I18n Options for <code>useI18n</code> |
+|  [VueI18n](./vue-i18n.vuei18n.md) | VueI18n Interfaces |
 |  [WarnHtmlInMessageLevel](./vue-i18n.warnhtmlinmessagelevel.md) |  |
 
diff --git a/docs/vue-i18n.usei18noptions.md b/docs/vue-i18n.usei18noptions.md
@@ -4,8 +4,15 @@
 
 ## UseI18nOptions type
 
+I18n Options for `useI18n`
+
 <b>Signature:</b>
 
 ```typescript
 export declare type UseI18nOptions = ComposerAdditionalOptions & ComposerOptions;
 ```
+
+## Remarks
+
+`UseI18nOptions` is inherited [ComposerAdditionalOptions](./vue-i18n.composeradditionaloptions.md) and [ComposerOptions](./vue-i18n.composeroptions.md)<!-- -->, so you can specify these options.
+
diff --git a/docs/vue-i18n.version.md b/docs/vue-i18n.version.md
@@ -4,6 +4,8 @@
 
 ## VERSION variable
 
+vue-i18n version
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/docs/vue-i18n.vuei18n.md b/docs/vue-i18n.vuei18n.md
@@ -6,8 +6,6 @@
 
 VueI18n Interfaces
 
-This interface is compatible with interface of `VueI18n` class (offered with vue-i18n<!-- -->@<!-- -->8.x).
-
 <b>Signature:</b>
 
 ```typescript
@@ -29,6 +27,7 @@ export declare type VueI18n = {
     formatFallbackMessages: boolean;
     sync: boolean;
     warnHtmlInMessage: WarnHtmlInMessageLevel;
+    preserveDirectiveContent: boolean;
     __id: number;
     __composer: Composer;
     /*!
@@ -77,3 +76,8 @@ export declare type VueI18n = {
     getChoiceIndex: (choice: Choice, choicesLength: number) => number;
 };
 ```
+
+## Remarks
+
+This interface is compatible with interface of `VueI18n` class (offered with vue-i18n<!-- -->@<!-- -->8.x).
+
diff --git a/docs/vue-i18n.vuei18noptions.md b/docs/vue-i18n.vuei18noptions.md
@@ -6,14 +6,16 @@
 
 VueI18n Options
 
-This option is compatible with the constructor options of `VueI18n` class (offered with vue-i18n<!-- -->@<!-- -->8.x).
-
 <b>Signature:</b>
 
 ```typescript
 export interface VueI18nOptions 
 ```
 
+## Remarks
+
+This option is compatible with the constructor options of `VueI18n` class (offered with vue-i18n<!-- -->@<!-- -->8.x).
+
 ## Properties
 
 |  Property | Type | Description |