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

feat(useAsyncQueue): add options.signal parameter #3033

Merged
merged 1 commit into from May 15, 2023
Merged

feat(useAsyncQueue): add options.signal parameter #3033

merged 1 commit into from May 15, 2023

Conversation

ghost
Copy link

@ghost ghost commented Apr 27, 2023

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

The signal option can be set to an AbortSignal to allow aborting an asynchronous queue task via the corresponding AbortController.

Example

const controller = new AbortController()
const p = () => {
  if (/* condition */) {
    controller.abort()
  }
}
const { activeIndex, result } = useAsyncQueue([/* ... */ p, /* ... */], {
  signal: controller.signal,
})

Additional context


🤖 Generated by Copilot at 986338d

The pull request enhances the useAsyncQueue function to allow canceling async tasks with an AbortSignal. It also improves the code quality and testing of the function and its related files.

🤖 Generated by Copilot at 986338d

  • Update UseAsyncQueueResult interface to include canceled state (link)
  • Add optional signal property to UseAsyncQueueOptions interface (link)
  • Reformat overloaded function signatures for readability (link)
  • Check signal status before and after each task and update result state accordingly (link)
  • Use Promise.race to resolve or reject promise based on signal or task outcome (link)
  • Define custom AbortError class and helper function whenAborted (link)
  • Add test case for canceling tasks using an AbortSignal in index.test.ts (link)
  • Reformat and correct code style in index.test.ts (link, link, link, link)
    • Break long string into two lines and align arguments of expect and toBe (link)
    • Remove extra spaces before opening parentheses of it functions (link, link, link)

antfu
antfu previously requested changes May 1, 2023
Copy link
Member

@antfu antfu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please revert unrelated format changes before I can start reviewing. Thanks.

@ghost ghost requested a review from antfu May 3, 2023 04:03
@antfu antfu dismissed their stale review May 9, 2023 09:50

resolved

@ghost ghost requested a review from antfu May 10, 2023 07:53
sxzz
sxzz previously approved these changes May 12, 2023

export type UseAsyncQueueTask<T> = (...args: any[]) => T | Promise<T>

export interface UseAsyncQueueResult<T> {
state: 'pending' | 'fulfilled' | 'rejected'
state: 'canceled' | 'fulfilled' | 'pending' | 'rejected'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
state: 'canceled' | 'fulfilled' | 'pending' | 'rejected'
state: 'aborted' | 'fulfilled' | 'pending' | 'rejected'

@ghost ghost requested a review from sxzz May 13, 2023 02:42
@antfu antfu merged commit 7da7c4e into vueuse:main May 15, 2023
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants