fix(types): app.component should accept defineComponent return type

fix #730
vuejs · Feb 16, 2020 · 57ee5df · 57ee5df
1 parent 9d2ac66
commit 57ee5df
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 13 deletions.
diff --git a/packages/runtime-core/src/apiCreateApp.ts b/packages/runtime-core/src/apiCreateApp.ts
@@ -1,4 +1,9 @@
-import { Component, Data, validateComponentName } from './component'
+import {
+  Component,
+  Data,
+  validateComponentName,
+  PublicAPIComponent
+} from './component'
 import { ComponentOptions } from './apiOptions'
 import { ComponentPublicInstance } from './componentProxy'
 import { Directive, validateDirectiveName } from './directives'
@@ -82,10 +87,7 @@ export function createAppContext(): AppContext {
 }
 
 export type CreateAppFunction<HostElement> = (
-  rootComponent:
-    | Component
-    // for compatibility with defineComponent() return types
-    | { new (): ComponentPublicInstance<any, any, any, any, any> },
+  rootComponent: PublicAPIComponent,
   rootProps?: Data | null
 ) => App<HostElement>
 
@@ -156,7 +158,7 @@ export function createAppAPI<HostNode, HostElement>(
         return app
       },
 
-      component(name: string, component?: Component): any {
+      component(name: string, component?: PublicAPIComponent): any {
         if (__DEV__) {
           validateComponentName(name, context.config)
         }
@@ -166,7 +168,7 @@ export function createAppAPI<HostNode, HostElement>(
         if (__DEV__ && context.components[name]) {
           warn(`Component "${name}" has already been registered in target app.`)
         }
-        context.components[name] = component
+        context.components[name] = component as Component
         return app
       },
 

diff --git a/packages/runtime-core/src/apiOptions.ts b/packages/runtime-core/src/apiOptions.ts
@@ -1,10 +1,10 @@
 import {
   ComponentInternalInstance,
   Data,
-  Component,
   SetupContext,
   RenderFunction,
-  SFCInternalOptions
+  SFCInternalOptions,
+  PublicAPIComponent
 } from './component'
 import {
   isFunction,
@@ -70,10 +70,7 @@ export interface ComponentOptionsBase<
     push: (item: any) => void,
     parentInstance: ComponentInternalInstance
   ) => void
-  components?: Record<
-    string,
-    Component | { new (): ComponentPublicInstance<any, any, any, any, any> }
-  >
+  components?: Record<string, PublicAPIComponent>
   directives?: Record<string, Directive>
   inheritAttrs?: boolean
 

diff --git a/packages/runtime-core/src/component.ts b/packages/runtime-core/src/component.ts
@@ -53,6 +53,13 @@ export interface FunctionalComponent<P = {}> extends SFCInternalOptions {
 }
 
 export type Component = ComponentOptions | FunctionalComponent
+
+// A type used in public APIs where a component type is expected.
+// The constructor type is an artificial type returned by defineComponent().
+export type PublicAPIComponent =
+  | Component
+  | { new (): ComponentPublicInstance<any, any, any, any, any> }
+
 export { ComponentOptions }
 
 type LifecycleHook = Function[] | null