Skip to content

fix(types): allow async functions in useDebounceFn and useThrottleFn #5131

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

Jump to bottom
Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

fix(types): allow async functions in useDebounceFn and useThrottleFn #5131

wants to merge 4 commits into from
+1 −1

Conversation

@xiaoxiaohuayu
Copy link

@xiaoxiaohuayu xiaoxiaohuayu commented Oct 31, 2025 •
edited by 9romise
Loading

Before submitting the PR, please make sure you do the following

  • Read the Contributing Guidelines.
  • Read the Pull Request Guidelines.
  • Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate.
  • Provide a description in this PR that addresses what the PR is solving, or reference the issue that it solves (e.g. fixes #123).
  • Ideally, include relevant tests that fail without this PR but pass with it.
⚠️ Slowing down new functions

Warning: Slowing down new functions

As the VueUse audience continues to grow, we have been inundated with an overwhelming number of feature requests and pull requests. As a result, maintaining the project has become increasingly challenging and has stretched our capacity to its limits. As such, in the near future, we may need to slow down our acceptance of new features and prioritize the stability and quality of existing functions. Please note that new features for VueUse may not be accepted at this time. If you have any new ideas, we suggest that you first incorporate them into your own codebase, iterate on them to suit your needs, and assess their generalizability. If you strongly believe that your ideas are beneficial to the community, you may submit a pull request along with your use cases, and we would be happy to review and discuss them. Thank you for your understanding.

Description

Resolve #4082
Fixes TypeScript ESLint warning when passing async functions to useDebounceFn and useThrottleFn.

When using the @typescript-eslint/no-misused-promises rule, passing async functions (or any function returning a Promise) to useDebounceFn or useThrottleFn triggers the following warning:

Additional context

// Before
export type FunctionArgs<Args extends any[] = any[], Return = void> = (...args: Args) => Return

// After  
export type FunctionArgs<Args extends any[] = any[], Return = any> = (...args: Args) => Return

@dosubot dosubot bot added the size:XS This PR changes 0-9 lines, ignoring generated files. label Oct 31, 2025
OrbisK
OrbisK requested changes Oct 31, 2025
View reviewed changes
@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Oct 31, 2025
@pkg-pr-new
Copy link

pkg-pr-new bot commented Oct 31, 2025

Open in StackBlitz

@vueuse/components

npm i https://pkg.pr.new/@vueuse/components@5131

@vueuse/core

npm i https://pkg.pr.new/@vueuse/core@5131

@vueuse/electron

npm i https://pkg.pr.new/@vueuse/electron@5131

@vueuse/firebase

npm i https://pkg.pr.new/@vueuse/firebase@5131

@vueuse/integrations

npm i https://pkg.pr.new/@vueuse/integrations@5131

@vueuse/math

npm i https://pkg.pr.new/@vueuse/math@5131

@vueuse/metadata

npm i https://pkg.pr.new/@vueuse/metadata@5131

@vueuse/nuxt

npm i https://pkg.pr.new/@vueuse/nuxt@5131

@vueuse/router

npm i https://pkg.pr.new/@vueuse/router@5131

@vueuse/rxjs

npm i https://pkg.pr.new/@vueuse/rxjs@5131

@vueuse/shared

npm i https://pkg.pr.new/@vueuse/shared@5131

commit: e2fe741

@9romise 9romise changed the title fix(types): allow async functions in useDebounceFn and useThrottleFn(#4082) fix(types): allow async functions in useDebounceFn and useThrottleFn Oct 31, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@OrbisK OrbisK OrbisK approved these changes

Assignees

No one assigned

Labels

lgtm This PR has been approved by a maintainer size:XS This PR changes 0-9 lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

useDebounceFn should support accepting functions that return promises as well as void

2 participants

@xiaoxiaohuayu @OrbisK