feat: TypeScript support #43
Conversation
kazupon
left a comment
There was a problem hiding this comment.
/ping @ktsn @HerringtonDarkholme
Could you review this PR?
types/index.d.ts
Outdated
| @@ -0,0 +1,8 @@ | |||
| import * as VueJS from 'vue' | |||
There was a problem hiding this comment.
To adjust to the type definitions of other libraries, I think that we should be directly import rather than as using.
import _Vue from 'vue'ref: vuex https://github.com/vuejs/vuex/blob/dev/types/index.d.ts#L1
types/index.d.ts
Outdated
| import * as VueJS from 'vue' | ||
|
|
||
| declare function wrap( | ||
| Vue: VueJS.default, |
There was a problem hiding this comment.
From the above, I think that it will be below using typeof.
Vue: typeof _Vue
types/index.d.ts
Outdated
|
|
||
| declare function wrap( | ||
| Vue: VueJS.default, | ||
| Component: VueJS.VueConstructor<VueJS.default> |
There was a problem hiding this comment.
Considering the asynchronous component, i think we should be defined the below.
ComponentOptions<Vue> | typeof Vue | AsyncComponentref: vue-router
https://github.com/vuejs/vue-router/blob/dev/types/router.d.ts#L3
There was a problem hiding this comment.
Component | AsyncComponent may be better, I guess. It includes functional component and the type parameter of ComponentOption is never which makes it the top type in type parameters variation as the type param is contravariant.
types/index.d.ts
Outdated
| @@ -0,0 +1,10 @@ | |||
| import _Vue, { AsyncComponent, ComponentOptions } from 'vue' | |||
There was a problem hiding this comment.
~~ I think we already have exported Component from vue. Can we use it? https://github.com/vuejs/vue/blob/dev/types/index.d.ts#L13 ~~
@ktsn has already pointed that out.
There was a problem hiding this comment.
@HerringtonDarkholme
Sorry, I was misreading.
I corresponded. thank you for review 🙏
There was a problem hiding this comment.
I forget to include AsyncComponent, sorry! 😢
There was a problem hiding this comment.
@HerringtonDarkholme
Is the following code correct?
declare function wrap(
Vue: typeof _Vue,
Component: Component | AsyncComponent
): HTMLElement|
@potato4d Thanks! |
| declare function wrap( | ||
| Vue: typeof _Vue, | ||
| Component: Component | AsyncComponent | ||
| ): HTMLElement |
There was a problem hiding this comment.
Hi @potato4d,
I'm wondering if the return type here is correct.
(I'm expecting something like CustomElementConstructor so it can be passed to CustomElementRegistry.define().)
There was a problem hiding this comment.
This is indeed wrong , it should be CustomElementConstructor.
Changes