fix: support pending(fn: Callback, n: number)

[fengmk2]

Summary by CodeRabbit

• New Features

  • Enhanced pending function with improved parameter handling and flexibility
  • Added support for multiple function signature variations

• Bug Fixes

  • Improved type safety for function parameter handling

• Refactor

  • Updated internal implementation of pending function to support more versatile usage patterns

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces modifications to the pending function in src/index.ts, enhancing its method signature and parameter handling. The function now supports two overloaded signatures that provide more flexible parameter ordering, allowing developers to pass a callback and a number in different sequences. The changes aim to improve the function's type safety and usability while maintaining backward compatibility with existing implementations.

Changes

File	Change Summary
src/index.ts	- Updated pending function signatures to support multiple parameter orders - Introduced new logic for handling callback and number parameters - Modified internal callback invocation mechanism
test/pedding.test.ts	- Removed type assertions (as any) in test case - Simplified type casting for done function

Sequence Diagram

sequenceDiagram
    participant Developer
    participant PendingFunction
    participant Callback

    Developer->>PendingFunction: Call with (callback, number)
    PendingFunction-->>Developer: Returns wrapper function
    Developer->>PendingFunction: Call wrapper with optional error
    PendingFunction->>Callback: Invoke callback when conditions met

Loading

Poem

🐰 A rabbit's tale of pending delight,
Where functions dance with type-safe might,
Callbacks twirl in new array,
Flexibility finds its way today,
Code hops with joy, pure and bright! 🎉

---

📜 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 132f38b and 741c591.

📒 Files selected for processing (2)

• src/index.ts (2 hunks)
• test/pedding.test.ts (1 hunks)

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @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.

[pkg-pr-new]

Open in Stackblitz

npm i https://pkg.pr.new/node-modules/pedding@7

commit: 741c591

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (d2352dc) to head (741c591).
Report is 2 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff            @@
##            master        #7   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            1         1           
  Lines           51        55    +4     
  Branches        11        12    +1     
=========================================
+ Hits            51        55    +4     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.