Skip to content
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

chore(runtime-core): rename createAsyncComponent as defineAsyncComponent #888

Merged
merged 1 commit into from
Mar 26, 2020
Merged

chore(runtime-core): rename createAsyncComponent as defineAsyncComponent #888

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
30 changes: 15 additions & 15 deletions packages/runtime-core/__tests__/apiAsyncComponent.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import {
createAsyncComponent,
defineAsyncComponent,
h,
Component,
ref,
Expand All @@ -10,10 +10,10 @@ import { createApp, nodeOps, serializeInner } from '@vue/runtime-test'

const timeout = (n: number = 0) => new Promise(r => setTimeout(r, n))

describe('api: createAsyncComponent', () => {
describe('api: defineAsyncComponent', () => {
test('simple usage', async () => {
let resolve: (comp: Component) => void
const Foo = createAsyncComponent(
const Foo = defineAsyncComponent(
() =>
new Promise(r => {
resolve = r as any
Expand Down Expand Up @@ -47,7 +47,7 @@ describe('api: createAsyncComponent', () => {

test('with loading component', async () => {
let resolve: (comp: Component) => void
const Foo = createAsyncComponent({
const Foo = defineAsyncComponent({
loader: () =>
new Promise(r => {
resolve = r as any
Expand Down Expand Up @@ -87,7 +87,7 @@ describe('api: createAsyncComponent', () => {

test('with loading component + explicit delay (0)', async () => {
let resolve: (comp: Component) => void
const Foo = createAsyncComponent({
const Foo = defineAsyncComponent({
loader: () =>
new Promise(r => {
resolve = r as any
Expand Down Expand Up @@ -124,7 +124,7 @@ describe('api: createAsyncComponent', () => {
test('error without error component', async () => {
let resolve: (comp: Component) => void
let reject: (e: Error) => void
const Foo = createAsyncComponent(
const Foo = defineAsyncComponent(
() =>
new Promise((_resolve, _reject) => {
resolve = _resolve as any
Expand Down Expand Up @@ -169,7 +169,7 @@ describe('api: createAsyncComponent', () => {
test('error with error component', async () => {
let resolve: (comp: Component) => void
let reject: (e: Error) => void
const Foo = createAsyncComponent({
const Foo = defineAsyncComponent({
loader: () =>
new Promise((_resolve, _reject) => {
resolve = _resolve as any
Expand Down Expand Up @@ -214,7 +214,7 @@ describe('api: createAsyncComponent', () => {
test('error with error + loading components', async () => {
let resolve: (comp: Component) => void
let reject: (e: Error) => void
const Foo = createAsyncComponent({
const Foo = defineAsyncComponent({
loader: () =>
new Promise((_resolve, _reject) => {
resolve = _resolve as any
Expand Down Expand Up @@ -270,7 +270,7 @@ describe('api: createAsyncComponent', () => {

test('timeout without error component', async () => {
let resolve: (comp: Component) => void
const Foo = createAsyncComponent({
const Foo = defineAsyncComponent({
loader: () =>
new Promise(_resolve => {
resolve = _resolve as any
Expand Down Expand Up @@ -304,7 +304,7 @@ describe('api: createAsyncComponent', () => {

test('timeout with error component', async () => {
let resolve: (comp: Component) => void
const Foo = createAsyncComponent({
const Foo = defineAsyncComponent({
loader: () =>
new Promise(_resolve => {
resolve = _resolve as any
Expand Down Expand Up @@ -336,7 +336,7 @@ describe('api: createAsyncComponent', () => {

test('timeout with error + loading components', async () => {
let resolve: (comp: Component) => void
const Foo = createAsyncComponent({
const Foo = defineAsyncComponent({
loader: () =>
new Promise(_resolve => {
resolve = _resolve as any
Expand Down Expand Up @@ -369,7 +369,7 @@ describe('api: createAsyncComponent', () => {

test('timeout without error component, but with loading component', async () => {
let resolve: (comp: Component) => void
const Foo = createAsyncComponent({
const Foo = defineAsyncComponent({
loader: () =>
new Promise(_resolve => {
resolve = _resolve as any
Expand Down Expand Up @@ -405,7 +405,7 @@ describe('api: createAsyncComponent', () => {

test('with suspense', async () => {
let resolve: (comp: Component) => void
const Foo = createAsyncComponent(
const Foo = defineAsyncComponent(
() =>
new Promise(_resolve => {
resolve = _resolve as any
Expand All @@ -432,7 +432,7 @@ describe('api: createAsyncComponent', () => {

test('suspensible: false', async () => {
let resolve: (comp: Component) => void
const Foo = createAsyncComponent({
const Foo = defineAsyncComponent({
loader: () =>
new Promise(_resolve => {
resolve = _resolve as any
Expand Down Expand Up @@ -461,7 +461,7 @@ describe('api: createAsyncComponent', () => {

test('suspense with error handling', async () => {
let reject: (e: Error) => void
const Foo = createAsyncComponent(
const Foo = defineAsyncComponent(
() =>
new Promise((_resolve, _reject) => {
reject = _reject
Expand Down
36 changes: 18 additions & 18 deletions packages/runtime-core/__tests__/components/Suspense.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ describe('Suspense', () => {
})

// a simple async factory for testing purposes only.
function createAsyncComponent<T extends ComponentOptions>(
function defineAsyncComponent<T extends ComponentOptions>(
comp: T,
delay: number = 0
) {
Expand All @@ -42,7 +42,7 @@ describe('Suspense', () => {
}

test('fallback content', async () => {
const Async = createAsyncComponent({
const Async = defineAsyncComponent({
render() {
return h('div', 'async')
}
Expand Down Expand Up @@ -70,7 +70,7 @@ describe('Suspense', () => {
test('nested async deps', async () => {
const calls: string[] = []

const AsyncOuter = createAsyncComponent({
const AsyncOuter = defineAsyncComponent({
setup() {
onMounted(() => {
calls.push('outer mounted')
Expand All @@ -79,7 +79,7 @@ describe('Suspense', () => {
}
})

const AsyncInner = createAsyncComponent(
const AsyncInner = defineAsyncComponent(
{
setup() {
onMounted(() => {
Expand Down Expand Up @@ -118,7 +118,7 @@ describe('Suspense', () => {
})

test('onResolve', async () => {
const Async = createAsyncComponent({
const Async = defineAsyncComponent({
render() {
return h('div', 'async')
}
Expand Down Expand Up @@ -221,7 +221,7 @@ describe('Suspense', () => {
})

test('content update before suspense resolve', async () => {
const Async = createAsyncComponent({
const Async = defineAsyncComponent({
setup(props: { msg: string }) {
return () => h('div', props.msg)
}
Expand Down Expand Up @@ -321,7 +321,7 @@ describe('Suspense', () => {
const toggle = ref(true)
const unmounted = jest.fn()

const Async = createAsyncComponent({
const Async = defineAsyncComponent({
setup() {
onUnmounted(unmounted)
return () => h('div', 'async')
Expand Down Expand Up @@ -360,7 +360,7 @@ describe('Suspense', () => {
const mounted = jest.fn()
const unmounted = jest.fn()

const Async = createAsyncComponent({
const Async = defineAsyncComponent({
setup() {
onMounted(mounted)
onUnmounted(unmounted)
Expand Down Expand Up @@ -400,7 +400,7 @@ describe('Suspense', () => {
test('nested suspense (parent resolves first)', async () => {
const calls: string[] = []

const AsyncOuter = createAsyncComponent(
const AsyncOuter = defineAsyncComponent(
{
setup: () => {
onMounted(() => {
Expand All @@ -412,7 +412,7 @@ describe('Suspense', () => {
1
)

const AsyncInner = createAsyncComponent(
const AsyncInner = defineAsyncComponent(
{
setup: () => {
onMounted(() => {
Expand Down Expand Up @@ -466,7 +466,7 @@ describe('Suspense', () => {
test('nested suspense (child resolves first)', async () => {
const calls: string[] = []

const AsyncOuter = createAsyncComponent(
const AsyncOuter = defineAsyncComponent(
{
setup: () => {
onMounted(() => {
Expand All @@ -478,7 +478,7 @@ describe('Suspense', () => {
10
)

const AsyncInner = createAsyncComponent(
const AsyncInner = defineAsyncComponent(
{
setup: () => {
onMounted(() => {
Expand Down Expand Up @@ -568,7 +568,7 @@ describe('Suspense', () => {
const msg = ref('nested msg')
const calls: number[] = []

const AsyncChildWithSuspense = createAsyncComponent({
const AsyncChildWithSuspense = defineAsyncComponent({
setup(props: { msg: string }) {
onMounted(() => {
calls.push(0)
Expand All @@ -581,7 +581,7 @@ describe('Suspense', () => {
}
})

const AsyncInsideNestedSuspense = createAsyncComponent(
const AsyncInsideNestedSuspense = defineAsyncComponent(
{
setup(props: { msg: string }) {
onMounted(() => {
Expand All @@ -593,7 +593,7 @@ describe('Suspense', () => {
20
)

const AsyncChildParent = createAsyncComponent({
const AsyncChildParent = defineAsyncComponent({
setup(props: { msg: string }) {
onMounted(() => {
calls.push(1)
Expand All @@ -602,7 +602,7 @@ describe('Suspense', () => {
}
})

const NestedAsyncChild = createAsyncComponent(
const NestedAsyncChild = defineAsyncComponent(
{
setup(props: { msg: string }) {
onMounted(() => {
Expand Down Expand Up @@ -692,13 +692,13 @@ describe('Suspense', () => {
test('new async dep after resolve should cause suspense to restart', async () => {
const toggle = ref(false)

const ChildA = createAsyncComponent({
const ChildA = defineAsyncComponent({
setup() {
return () => h('div', 'Child A')
}
})

const ChildB = createAsyncComponent({
const ChildB = defineAsyncComponent({
setup() {
return () => h('div', 'Child B')
}
Expand Down
6 changes: 3 additions & 3 deletions packages/runtime-core/__tests__/hydration.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import {
createStaticVNode,
Suspense,
onMounted,
createAsyncComponent
defineAsyncComponent
} from '@vue/runtime-dom'
import { renderToString } from '@vue/server-renderer'
import { mockWarn } from '@vue/shared'
Expand Down Expand Up @@ -394,7 +394,7 @@ describe('SSR hydration', () => {
)

let serverResolve: any
let AsyncComp = createAsyncComponent(
let AsyncComp = defineAsyncComponent(
() =>
new Promise(r => {
serverResolve = r
Expand All @@ -417,7 +417,7 @@ describe('SSR hydration', () => {

// hydration
let clientResolve: any
AsyncComp = createAsyncComponent(
AsyncComp = defineAsyncComponent(
() =>
new Promise(r => {
clientResolve = r
Expand Down
2 changes: 1 addition & 1 deletion packages/runtime-core/src/apiAsyncComponent.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ export interface AsyncComponentOptions<T = any> {
suspensible?: boolean
}

export function createAsyncComponent<
export function defineAsyncComponent<
T extends PublicAPIComponent = { new (): ComponentPublicInstance }
>(source: AsyncComponentLoader<T> | AsyncComponentOptions<T>): T {
if (isFunction(source)) {
Expand Down
2 changes: 1 addition & 1 deletion packages/runtime-core/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ export {
export { provide, inject } from './apiInject'
export { nextTick } from './scheduler'
export { defineComponent } from './apiDefineComponent'
export { createAsyncComponent } from './apiAsyncComponent'
export { defineAsyncComponent } from './apiAsyncComponent'

// Advanced API ----------------------------------------------------------------

Expand Down