Skip to content

fix(typings): wrongly typed AsyncComponentFactory #9787

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

fix(typings): wrongly typed AsyncComponentFactory #9787

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions types/options.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,21 +12,26 @@ export type Component<Data=DefaultData<never>, Methods=DefaultMethods<never>, Co
| FunctionalComponentOptions<Props>
| ComponentOptions<never, Data, Methods, Computed, Props>

interface EsModuleComponent {
default: Component
export interface EsModuleComponent<Data=DefaultData<never>, Methods=DefaultMethods<never>, Computed=DefaultComputed, Props=DefaultProps> {
default: Component<Data, Methods, Computed, Props>
}

export type ComponentPromise<Data, Methods, Computed, Props> = Promise<
| Component<Data, Methods, Computed, Props>
| EsModuleComponent<Data, Methods, Computed, Props>
>

export type AsyncComponent<Data=DefaultData<never>, Methods=DefaultMethods<never>, Computed=DefaultComputed, Props=DefaultProps>
= AsyncComponentPromise<Data, Methods, Computed, Props>
| AsyncComponentFactory<Data, Methods, Computed, Props>

export type AsyncComponentPromise<Data=DefaultData<never>, Methods=DefaultMethods<never>, Computed=DefaultComputed, Props=DefaultProps> = (
resolve: (component: Component<Data, Methods, Computed, Props>) => void,
reject: (reason?: any) => void
) => Promise<Component | EsModuleComponent> | void;
) => ComponentPromise<Data, Methods, Computed, Props> | void

export type AsyncComponentFactory<Data=DefaultData<never>, Methods=DefaultMethods<never>, Computed=DefaultComputed, Props=DefaultProps> = () => {
component: AsyncComponentPromise<Data, Methods, Computed, Props>;
component: ComponentPromise<Data, Methods, Computed, Props>;
loading?: Component | EsModuleComponent;
error?: Component | EsModuleComponent;
delay?: number;
Expand Down
41 changes: 31 additions & 10 deletions types/test/options-test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,14 @@ Vue.component('component', {
resolve({} as ComponentOptions<Vue>);
reject();
}),
createElement((resolve) => {
resolve({} as Component);
}),
createElement(() => Promise.resolve({} as Component)),
createElement(() => ({
component: Promise.resolve({} as Component),
delay: 200
})),

"message",

Expand Down Expand Up @@ -438,16 +446,29 @@ Vue.component('functional-component-multi-root', {
}
})

Vue.component("async-component", ((resolve, reject) => {
setTimeout(() => {
resolve(Vue.component("component"));
}, 0);
return new Promise((resolve) => {
resolve({
functional: true,
render(h: CreateElement) { return h('div') }
});
})
Vue.component('async-component-executor', (resolve, reject) => {
try {
setTimeout(() => {
resolve(Vue.component('component'));
}, 0);
} catch (e) {
reject(e);
}
});

Vue.component('async-component-promise', () => {
return Promise.resolve({
functional: true,
render(h: CreateElement) { return h('div') }
});
});

Vue.component('async-component-factory', () => ({
component: Promise.resolve({
functional: true,
render(h: CreateElement) { return h('div') }
}),
delay: 123
}));

Vue.component('functional-component-v-model', {
Expand Down