Skip to content

fix(types): watchEffect typing does not support async callback (#14249) #14251

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
zhanghaifeng213 wants to merge 3 commits into
base: main
Choose a base branch
from
Open

fix(types): watchEffect typing does not support async callback (#14249) #14251

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c3a612e
fix(types): watchEffect typing does not support async callback (#14249)
Dec 26, 2025
bfb20cb
fix(types): watchEffect typing does not support async callback (#14249)
Dec 26, 2025
73ddef8
fix(types): watchEffect typing does not support async callback (#14249)
Dec 26, 2025
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
4 changes: 2 additions & 2 deletions packages/reactivity/src/watch.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ export enum WatchErrorCodes {
WATCH_CLEANUP,
}

export type WatchEffect = (onCleanup: OnCleanup) => void
export type WatchEffect = (onCleanup: OnCleanup) => Promise<void> | void
Comment thread
coderabbitai[bot] marked this conversation as resolved.

export type WatchSource<T = any> = Ref<T, any> | ComputedRef<T> | (() => T)

Expand All @@ -44,7 +44,7 @@ export type WatchCallback<V = any, OV = any> = (
onCleanup: OnCleanup,
) => any

export type OnCleanup = (cleanupFn: () => void) => void
export type OnCleanup = (cleanupFn: () => void) => Promise<void> | void
Comment thread
coderabbitai[bot] marked this conversation as resolved.
Outdated

export interface WatchOptions<Immediate = boolean> extends DebuggerOptions {
immediate?: Immediate
Expand Down
4 changes: 2 additions & 2 deletions packages/runtime-core/__tests__/apiWatch.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1104,8 +1104,8 @@ describe('api: watch', () => {
const spy = vi.fn()
watchEffect(
() => {
spy()
return arr
spy(arr)
return
},
// @ts-expect-error
{ deep: true },
Expand Down