Skip to content

Commit 91989ae

Browse files
committed
refactor: typings
1 parent 626a6d9 commit 91989ae

File tree

54 files changed

+626
-103
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+626
-103
lines changed
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
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; [ComposerAdditionalOptions](./vue-i18n.composeradditionaloptions.md)
4+
5+
## ComposerAdditionalOptions interface
6+
7+
Composer additional options
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
export interface ComposerAdditionalOptions
13+
```
14+
15+
## Remarks
16+
17+
`ComposerAdditionalOptions` is extend for [ComposerOptions](./vue-i18n.composeroptions.md)<!-- -->, so you can specify these options.
18+
19+
## Properties
20+
21+
| Property | Type | Description |
22+
| --- | --- | --- |
23+
| [useScope](./vue-i18n.composeradditionaloptions.usescope.md) | <code>I18nScope</code> | |
24+
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
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; [ComposerAdditionalOptions](./vue-i18n.composeradditionaloptions.md) &gt; [useScope](./vue-i18n.composeradditionaloptions.usescope.md)
4+
5+
## ComposerAdditionalOptions.useScope property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
useScope?: I18nScope;
11+
```
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
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; [ComposerOptions](./vue-i18n.composeroptions.md) &gt; [datetimeFormats](./vue-i18n.composeroptions.datetimeformats.md)
4+
5+
## ComposerOptions.datetimeFormats property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
datetimeFormats?: DateTimeFormats;
11+
```
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
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; [ComposerOptions](./vue-i18n.composeroptions.md) &gt; [fallbackFormat](./vue-i18n.composeroptions.fallbackformat.md)
4+
5+
## ComposerOptions.fallbackFormat property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
fallbackFormat?: boolean;
11+
```
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
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; [ComposerOptions](./vue-i18n.composeroptions.md) &gt; [fallbackLocale](./vue-i18n.composeroptions.fallbacklocale.md)
4+
5+
## ComposerOptions.fallbackLocale property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
fallbackLocale?: FallbackLocale;
11+
```
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
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; [ComposerOptions](./vue-i18n.composeroptions.md) &gt; [fallbackRoot](./vue-i18n.composeroptions.fallbackroot.md)
4+
5+
## ComposerOptions.fallbackRoot property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
fallbackRoot?: boolean;
11+
```
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
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; [ComposerOptions](./vue-i18n.composeroptions.md) &gt; [fallbackWarn](./vue-i18n.composeroptions.fallbackwarn.md)
4+
5+
## ComposerOptions.fallbackWarn property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
fallbackWarn?: boolean | RegExp;
11+
```
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
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; [ComposerOptions](./vue-i18n.composeroptions.md) &gt; [inheritLocale](./vue-i18n.composeroptions.inheritlocale.md)
4+
5+
## ComposerOptions.inheritLocale property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
inheritLocale?: boolean;
11+
```
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
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; [ComposerOptions](./vue-i18n.composeroptions.md) &gt; [locale](./vue-i18n.composeroptions.locale.md)
4+
5+
## ComposerOptions.locale property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
locale?: Locale;
11+
```

docs/vue-i18n.composeroptions.md

Lines changed: 23 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[Home](./index.md) &gt; [vue-i18n](./vue-i18n.md) &gt; [ComposerOptions](./vue-i18n.composeroptions.md)
44

5-
## ComposerOptions type
5+
## ComposerOptions interface
66

77
Composer Options
88

@@ -11,23 +11,26 @@ This is options to create composer.
1111
<b>Signature:</b>
1212

1313
```typescript
14-
export declare type ComposerOptions = {
15-
locale?: Locale;
16-
fallbackLocale?: FallbackLocale;
17-
inheritLocale?: boolean;
18-
messages?: LocaleMessages;
19-
datetimeFormats?: DateTimeFormats;
20-
numberFormats?: NumberFormats;
21-
modifiers?: LinkedModifiers;
22-
pluralRules?: PluralizationRules;
23-
missing?: MissingHandler;
24-
missingWarn?: boolean | RegExp;
25-
fallbackWarn?: boolean | RegExp;
26-
fallbackRoot?: boolean;
27-
fallbackFormat?: boolean;
28-
postTranslation?: PostTranslationHandler;
29-
warnHtmlMessage?: boolean;
30-
__i18n?: CustomBlocks;
31-
__root?: Composer;
32-
};
14+
export interface ComposerOptions
3315
```
16+
17+
## Properties
18+
19+
| Property | Type | Description |
20+
| --- | --- | --- |
21+
| [datetimeFormats](./vue-i18n.composeroptions.datetimeformats.md) | <code>DateTimeFormats</code> | |
22+
| [fallbackFormat](./vue-i18n.composeroptions.fallbackformat.md) | <code>boolean</code> | |
23+
| [fallbackLocale](./vue-i18n.composeroptions.fallbacklocale.md) | <code>FallbackLocale</code> | |
24+
| [fallbackRoot](./vue-i18n.composeroptions.fallbackroot.md) | <code>boolean</code> | |
25+
| [fallbackWarn](./vue-i18n.composeroptions.fallbackwarn.md) | <code>boolean &#124; RegExp</code> | |
26+
| [inheritLocale](./vue-i18n.composeroptions.inheritlocale.md) | <code>boolean</code> | |
27+
| [locale](./vue-i18n.composeroptions.locale.md) | <code>Locale</code> | |
28+
| [messages](./vue-i18n.composeroptions.messages.md) | <code>LocaleMessages</code> | |
29+
| [missing](./vue-i18n.composeroptions.missing.md) | <code>MissingHandler</code> | |
30+
| [missingWarn](./vue-i18n.composeroptions.missingwarn.md) | <code>boolean &#124; RegExp</code> | |
31+
| [modifiers](./vue-i18n.composeroptions.modifiers.md) | <code>LinkedModifiers</code> | |
32+
| [numberFormats](./vue-i18n.composeroptions.numberformats.md) | <code>NumberFormats</code> | |
33+
| [pluralRules](./vue-i18n.composeroptions.pluralrules.md) | <code>PluralizationRules</code> | |
34+
| [postTranslation](./vue-i18n.composeroptions.posttranslation.md) | <code>PostTranslationHandler</code> | |
35+
| [warnHtmlMessage](./vue-i18n.composeroptions.warnhtmlmessage.md) | <code>boolean</code> | |
36+

0 commit comments

Comments
 (0)