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.

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

WatchCallback returns void, not any #12531

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

WatchCallback returns void, not any #12531

wants to merge 1 commit into from

Conversation

rotu
Copy link
Contributor

@rotu rotu commented Dec 11, 2024

This matches the documentation and better expresses that the return value is (mostly) ignored.

Copy link

Size Report

Bundles

File Size Gzip Brotli
runtime-dom.global.prod.js 100 kB 37.9 kB 34.2 kB
vue.global.prod.js 158 kB 57.8 kB 51.4 kB

Usages

Name Size Gzip Brotli
createApp (CAPI only) 46.6 kB 18.3 kB 16.7 kB
createApp 54.6 kB 21.3 kB 19.4 kB
createSSRApp 58.7 kB 23 kB 20.9 kB
defineCustomElement 59.4 kB 22.8 kB 20.8 kB
overall 68.4 kB 26.4 kB 24 kB

Copy link

pkg-pr-new bot commented Dec 11, 2024

Open in Stackblitz

@vue/compiler-core

npm i https://pkg.pr.new/@vue/compiler-core@12531

@vue/compiler-sfc

npm i https://pkg.pr.new/@vue/compiler-sfc@12531

@vue/compiler-ssr

npm i https://pkg.pr.new/@vue/compiler-ssr@12531

@vue/compiler-dom

npm i https://pkg.pr.new/@vue/compiler-dom@12531

@vue/runtime-core

npm i https://pkg.pr.new/@vue/runtime-core@12531

@vue/runtime-dom

npm i https://pkg.pr.new/@vue/runtime-dom@12531

@vue/reactivity

npm i https://pkg.pr.new/@vue/reactivity@12531

@vue/server-renderer

npm i https://pkg.pr.new/@vue/server-renderer@12531

@vue/shared

npm i https://pkg.pr.new/@vue/shared@12531

vue

npm i https://pkg.pr.new/vue@12531

@vue/compat

npm i https://pkg.pr.new/@vue/compat@12531

commit: 09e84ef

@rotu
Copy link
Contributor Author

rotu commented Dec 11, 2024

Maybe both the docs and the return type of WatchCallback should be changed to undefined | Promise<undefined>?

void provides very little type-checking since a function returning void may return any value.

Relevant discussion:
microsoft/TypeScript#42709

@edison1105 edison1105 added ready to merge The PR is ready to be merged. 🧹 p1-chore Priority 1: this doesn't change code behavior. labels Dec 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🧹 p1-chore Priority 1: this doesn't change code behavior. ready to merge The PR is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants