forked from vuejs/vue-class-component
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add a guide to annotate component type in decorator (vuejs#450)
- Loading branch information
Showing
2 changed files
with
47 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
# Annotate Component Type in Decorator | ||
|
||
There are cases that you want to use your component type on a function in `@Component` decorator argument. | ||
For example, to access component methods in a watch handler: | ||
|
||
```ts | ||
@Component({ | ||
watch: { | ||
postId(id: string) { | ||
// To fetch post data when the id is changed. | ||
this.fetchPost(id) // -> Property 'fetchPost' does not exist on type 'Vue'. | ||
} | ||
} | ||
}) | ||
class Post extends Vue { | ||
postId: string | ||
|
||
fetchPost(postId: string): Promise<void> { | ||
// ... | ||
} | ||
} | ||
``` | ||
|
||
The above code produces a type error that indicates `fetchPost` does not exist on `this` in the watch handler. This happens because `this` type in `@Component` decorator argument is the base `Vue` type. | ||
|
||
To use your own component type (in this case `Post`), you can annotate the decorator through its type parameter. | ||
|
||
```ts | ||
// Annotate the decorator with the component type 'Post' so that `this` type in | ||
// the decorator argument becomes 'Post'. | ||
@Component<Post>({ | ||
watch: { | ||
postId(id: string) { | ||
this.fetchPost(id) // -> No errors | ||
} | ||
} | ||
}) | ||
class Post extends Vue { | ||
postId: string | ||
|
||
fetchPost(postId: string): Promise<void> { | ||
// ... | ||
} | ||
} | ||
``` |