Skip to content

Commit 626a6d9

Browse files
kazuponkazupon
committed
update API docs
1 parent a2ee8e7 commit 626a6d9

25 files changed

+317
-22
lines changed

‎docs/vue-i18n.basecompile.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
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; [baseCompile](./vue-i18n.basecompile.md)
4+
5+
## baseCompile() function
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
export declare function baseCompile(source: string, options?: CompileOptions): CompileResult;
11+
```
12+
13+
## Parameters
14+
15+
| Parameter | Type | Description |
16+
| --- | --- | --- |
17+
| source | <code>string</code> | |
18+
| options | <code>CompileOptions</code> | |
19+
20+
<b>Returns:</b>
21+
22+
`CompileResult`
23+

‎docs/vue-i18n.compile.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
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; [compile](./vue-i18n.compile.md)
4+
5+
## compile() function
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
export declare function compile(source: string, options?: CompileOptions): MessageFunction;
11+
```
12+
13+
## Parameters
14+
15+
| Parameter | Type | Description |
16+
| --- | --- | --- |
17+
| source | <code>string</code> | |
18+
| options | <code>CompileOptions</code> | |
19+
20+
<b>Returns:</b>
21+
22+
`MessageFunction`
23+

‎docs/vue-i18n.compiledomain.md‎

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; [CompileDomain](./vue-i18n.compiledomain.md)
4+
5+
## CompileDomain type
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
export declare type CompileDomain = 'tokenizer' | 'parser' | 'generator' | 'transformer' | 'compiler';
11+
```

‎docs/vue-i18n.compileerror.code.md‎

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; [CompileError](./vue-i18n.compileerror.md) &gt; [code](./vue-i18n.compileerror.code.md)
4+
5+
## CompileError.code property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
code: CompileErrorCodes;
11+
```

‎docs/vue-i18n.compileerror.domain.md‎

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; [CompileError](./vue-i18n.compileerror.md) &gt; [domain](./vue-i18n.compileerror.domain.md)
4+
5+
## CompileError.domain property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
domain?: CompileDomain;
11+
```

‎docs/vue-i18n.compileerror.location.md‎

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; [CompileError](./vue-i18n.compileerror.md) &gt; [location](./vue-i18n.compileerror.location.md)
4+
5+
## CompileError.location property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
location?: SourceLocation;
11+
```

‎docs/vue-i18n.compileerror.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
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; [CompileError](./vue-i18n.compileerror.md)
4+
5+
## CompileError interface
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
export interface CompileError extends SyntaxError
11+
```
12+
13+
## Properties
14+
15+
| Property | Type | Description |
16+
| --- | --- | --- |
17+
| [code](./vue-i18n.compileerror.code.md) | <code>CompileErrorCodes</code> | |
18+
| [domain](./vue-i18n.compileerror.domain.md) | <code>CompileDomain</code> | |
19+
| [location](./vue-i18n.compileerror.location.md) | <code>SourceLocation</code> | |
20+

‎docs/vue-i18n.compileerrorcodes.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
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; [CompileErrorCodes](./vue-i18n.compileerrorcodes.md)
4+
5+
## CompileErrorCodes enum
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
export declare const enum CompileErrorCodes
11+
```
12+
13+
## Enumeration Members
14+
15+
| Member | Value | Description |
16+
| --- | --- | --- |
17+
| \_\_EXTEND\_POINT\_\_ | <code>11</code> | |
18+
| EMPTY\_PLACEHOLDER | <code>7</code> | |
19+
| EXPECTED\_TOKEN | <code>0</code> | |
20+
| INVALID\_LINKED\_FORMAT | <code>9</code> | |
21+
| INVALID\_TOKEN\_IN\_PLACEHOLDER | <code>1</code> | |
22+
| INVALID\_UNICODE\_ESCAPE\_SEQUENCE | <code>4</code> | |
23+
| MUST\_HAVE\_MESSAGES\_IN\_PLURAL | <code>10</code> | |
24+
| NOT\_ALLOW\_NEST\_PLACEHOLDER | <code>8</code> | |
25+
| UNBALANCED\_CLOSING\_BRACE | <code>5</code> | |
26+
| UNKNOWN\_ESCAPE\_SEQUENCE | <code>3</code> | |
27+
| UNTERMINATED\_CLOSING\_BRACE | <code>6</code> | |
28+
| UNTERMINATED\_SINGLE\_QUOTE\_IN\_PLACEHOLDER | <code>2</code> | |
29+

‎docs/vue-i18n.compileerrorhandler.md‎

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; [CompileErrorHandler](./vue-i18n.compileerrorhandler.md)
4+
5+
## CompileErrorHandler type
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
export declare type CompileErrorHandler = (error: CompileError) => void;
11+
```

‎docs/vue-i18n.composer.md‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,34 @@
66

77
Composer Interfaces
88

9+
This is the interface for being used for Vue 3 Composition API.
10+
911
<b>Signature:</b>
1012

1113
```typescript
1214
export declare type Composer = {
15+
/*!
16+
* properties
17+
*/
1318
locale: WritableComputedRef<Locale>;
1419
fallbackLocale: WritableComputedRef<FallbackLocale>;
20+
inheritLocale: boolean;
1521
readonly availableLocales: Locale[];
1622
readonly messages: ComputedRef<LocaleMessages>;
1723
readonly datetimeFormats: ComputedRef<DateTimeFormats>;
1824
readonly numberFormats: ComputedRef<NumberFormats>;
1925
readonly modifiers: LinkedModifiers;
2026
readonly pluralRules?: PluralizationRules;
27+
readonly isGlobal: boolean;
2128
missingWarn: boolean | RegExp;
2229
fallbackWarn: boolean | RegExp;
2330
fallbackRoot: boolean;
2431
fallbackFormat: boolean;
2532
warnHtmlMessage: boolean;
2633
__id: number;
34+
/*!
35+
* methods
36+
*/
2737
t(key: Path): string;
2838
t(key: Path, plural: number): string;
2939
t(key: Path, plural: number, options: TranslateOptions): string;
@@ -61,7 +71,6 @@ export declare type Composer = {
6171
setPostTranslationHandler(handler: PostTranslationHandler | null): void;
6272
getMissingHandler(): MissingHandler | null;
6373
setMissingHandler(handler: MissingHandler | null): void;
64-
install: Plugin;
6574
__transrateVNode(...args: unknown[]): unknown;
6675
__numberParts(...args: unknown[]): string | Intl.NumberFormatPart[];
6776
__datetimeParts(...args: unknown[]): string | Intl.DateTimeFormatPart[];

0 commit comments

Comments
 (0)