Skip to content

Commit 35f59cb

Browse files
committed
update docs
1 parent 9f3b53d commit 35f59cb

8 files changed

+59
-1
lines changed

docs/vue-i18n.compileoptions.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [vue-i18n](./vue-i18n.md) &gt; [CompileOptions](./vue-i18n.compileoptions.md)
4+
5+
## CompileOptions type
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
export declare type CompileOptions = {
11+
warnHtmlMessage?: boolean;
12+
onCacheKey?: CompileCacheKeyHandler;
13+
} & TransformOptions & CodeGenOptions & ParserOptions & TokenizeOptions;
14+
```

docs/vue-i18n.composer.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ export declare type Composer = {
2222
fallbackWarn: boolean | RegExp;
2323
fallbackRoot: boolean;
2424
fallbackFormat: boolean;
25+
warnHtmlMessage: boolean;
2526
__id: number;
2627
t(key: Path): string;
2728
t(key: Path, plural: number): string;

docs/vue-i18n.composeroptions.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ export declare type ComposerOptions = {
2323
fallbackRoot?: boolean;
2424
fallbackFormat?: boolean;
2525
postTranslation?: PostTranslationHandler;
26+
warnHtmlMessage?: boolean;
2627
__i18n?: CustomBlocks;
2728
__root?: Composer;
2829
};

docs/vue-i18n.createparser.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [vue-i18n](./vue-i18n.md) &gt; [createParser](./vue-i18n.createparser.md)
4+
5+
## createParser() function
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
export declare function createParser(options?: ParserOptions): Parser;
11+
```
12+
13+
## Parameters
14+
15+
| Parameter | Type | Description |
16+
| --- | --- | --- |
17+
| options | <code>ParserOptions</code> | |
18+
19+
<b>Returns:</b>
20+
21+
`Parser`
22+

docs/vue-i18n.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
| Function | Description |
1010
| --- | --- |
1111
| [createI18n(options)](./vue-i18n.createi18n.md) | I18n factory |
12+
| [createParser(options)](./vue-i18n.createparser.md) | |
1213
| [useI18n(options)](./vue-i18n.usei18n.md) | Use Composable API |
1314

1415
## Interfaces
@@ -32,6 +33,7 @@
3233
| Type Alias | Description |
3334
| --- | --- |
3435
| [Choice](./vue-i18n.choice.md) | |
36+
| [CompileOptions](./vue-i18n.compileoptions.md) | |
3537
| [Composer](./vue-i18n.composer.md) | Composer Interfaces |
3638
| [ComposerOptions](./vue-i18n.composeroptions.md) | Composer Options |
3739
| [CurrencyDisplay](./vue-i18n.currencydisplay.md) | number |
@@ -59,6 +61,7 @@
5961
| [NumberFormatResult](./vue-i18n.numberformatresult.md) | |
6062
| [NumberFormats](./vue-i18n.numberformats.md) | |
6163
| [NumberFormatToPartsResult](./vue-i18n.numberformattopartsresult.md) | |
64+
| [Parser](./vue-i18n.parser.md) | |
6265
| [Path](./vue-i18n.path.md) | |
6366
| [PathValue](./vue-i18n.pathvalue.md) | |
6467
| [PluralizationRule](./vue-i18n.pluralizationrule.md) | |

docs/vue-i18n.parser.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [vue-i18n](./vue-i18n.md) &gt; [Parser](./vue-i18n.parser.md)
4+
5+
## Parser type
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
export declare type Parser = Readonly<{
11+
parse: (source: string) => ResourceNode;
12+
}>;
13+
```

docs/vue-i18n.vuei18n.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@ export declare type VueI18n = {
2424
silentTranslationWarn: boolean | RegExp;
2525
silentFallbackWarn: boolean | RegExp;
2626
formatFallbackMessages: boolean;
27+
sync: boolean;
28+
warnHtmlInMessage: WarnHtmlInMessageLevel;
29+
__id: number;
30+
__composer: Composer;
2731
t(key: Path): TranslateResult;
2832
t(key: Path, locale: Locale): TranslateResult;
2933
t(key: Path, locale: Locale, list: unknown[]): TranslateResult;

docs/vue-i18n.vuei18noptions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@ export declare type VueI18nOptions = {
2222
formatter?: Formatter;
2323
missing?: MissingHandler;
2424
fallbackRoot?: boolean;
25-
sync?: boolean;
2625
silentTranslationWarn?: boolean | RegExp;
2726
silentFallbackWarn?: boolean | RegExp;
2827
formatFallbackMessages?: boolean;
@@ -31,6 +30,7 @@ export declare type VueI18nOptions = {
3130
sharedMessages?: LocaleMessages;
3231
pluralizationRules?: PluralizationRules;
3332
postTranslation?: PostTranslationHandler;
33+
sync?: boolean;
3434
__i18n?: CustomBlocks;
3535
__root?: Composer;
3636
};

0 commit comments

Comments
 (0)