fix(types): remove VoidFunction

[andreialecu]

Description

This is a simple change to remove VoidFunction which is not supposed to be a global. See: lukeed/uvu#89 (comment)

Related # (issue)

Fixes #2275

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as
  expected)
• This change requires a documentation update

[coderabbitai]

📝 Walkthrough

Summary by CodeRabbit

• Chores
  • Refined internal type definitions used in asynchronous operations and cleanup procedures to enhance clarity and type safety.
  • Updated test cases to align with these improvements.

These behind-the-scenes updates do not affect visible features or functionality but improve overall maintainability and long-term stability of the service.

Walkthrough

This PR updates type annotations in the promise helpers package to resolve a TypeScript compilation error. In the iterateAsync function, the endEarly parameter’s type has been changed from VoidFunction to () => void. Similarly, the test file for handleMaybePromise updates the mock type for onFinally from jest.Mock<VoidFunction> to jest.Mock<() => void>. The changes are limited to type declarations and maintain the original functionality.

Changes

File(s)	Change Summary
packages/promise-helpers/src/index.ts, packages/promise-helpers/tests/handleMaybePromise.spec.ts, .changeset/old-flowers-care.md	Updated callback types from VoidFunction to () => void in iterateAsync, test mocks, and changeset documentation, improving type clarity.

Assessment against linked issues

Objective	Addressed	Explanation
Resolve TS2552 error by replacing VoidFunction with () => void (#2275)	✅

Possibly related PRs

• feat(promise-helpers): add finally callback to handleMaybePromise #2152: Updates callback types in promise handling similar to the changes in this PR.

Suggested reviewers

• enisdenjo
• ardatan

Poem

I'm a hopping rabbit with code so neat,
Tiny changes made our types complete.
From VoidFunction's dusk to arrow's dawn,
Our code now hops with a yawn.
Celebrating clarity, we bound on! 🐇

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9fdc467 and 87e19d2.

📒 Files selected for processing (1)

• .changeset/old-flowers-care.md (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (14)

• GitHub Check: unit / deno
• GitHub Check: unit / bun
• GitHub Check: type check
• GitHub Check: unit / node 23
• GitHub Check: unit / node 22
• GitHub Check: lint
• GitHub Check: server (undici)
• GitHub Check: prettier
• GitHub Check: server (ponyfill)
• GitHub Check: unit / node 20
• GitHub Check: node-fetch (consumeBody)
• GitHub Check: server (native)
• GitHub Check: node-fetch (noConsumeBody)
• GitHub Check: unit / node 18

🔇 Additional comments (2)

.changeset/old-flowers-care.md (2)

1-3: Correct Changeset Header Format

The header section properly uses the YAML front matter delimiters (---) and specifies the package update as a patch. This format adheres to the expected changeset conventions.

---

5-5: Concise and Clear Change Description

The description clearly states the type change from VoidFunction to () => void and succinctly explains the intent behind the update. This aligns with the PR objectives for clarifying and correcting type annotations.

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[ardatan]

Thanks for creating the PR! Would you create a changeset with yarn changeset then we can bump the version and cut a new release? Thanks again!

[andreialecu]

Done