add finally

[w01fgang]

• ✨ add finally callback to Try class
• 🔖 bump version to 0.0.7

Summary by CodeRabbit

• New Features

  • Added support for registering a callback to be executed after an operation completes, regardless of success or failure, similar to Promise.prototype.finally.
  • Introduced a new method to enable this functionality through the public API.

• Documentation

  • Updated the README example to demonstrate usage of the new .finally() method.

• Tests

  • Added tests to verify that the new callback is executed after both successful and failed operations.

• Chores

  • Incremented the package version to 0.0.7.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes introduce a .finally() method to the Try class, allowing registration of a callback that executes after the wrapped function completes, regardless of its outcome. The TryConfig interface is updated to support this, relevant tests are added, and the README is updated with usage examples. The package version is incremented.

Changes

File(s)	Change Summary
README.md	Enhanced example to demonstrate .finally() usage in error handling patterns.
package.json	Incremented package version from 0.0.6 to 0.0.7.
src/tests/Try.test.ts	Added tests to verify .finally() callback execution on both success and failure cases.
src/nextjs/index.ts	Added finallyCallback to TryConfig, .finally() method to Try class, and logic to invoke callback after execution.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant TryInstance
    participant WrappedFunction
    participant FinallyCallback

    User->>TryInstance: .finally(callback)
    User->>TryInstance: .unwrap() / .value()
    TryInstance->>WrappedFunction: execute()
    WrappedFunction-->>TryInstance: result or error
    TryInstance->>FinallyCallback: invoke callback
    FinallyCallback-->>TryInstance: (callback completes)
    TryInstance-->>User: return result or throw error

Loading

Poem

In the land of code, where errors may fly,
A new friend appears—it's the brave .finally().
No matter success, or if things go awry,
A callback will run, as time hops by.
With tests and docs in perfect harmony,
The package now leaps to version 0.0.7—whee!
🐇✨

---

📜 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 517756f and a29d740.

📒 Files selected for processing (1)

• src/__tests__/Try.test.ts (1 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate Unit Tests

• Create PR with Unit Tests
• Post Copyable Unit Tests in Comment
• Commit Unit Tests in branch feat/add-finally

---

🪧 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai auto-generate unit tests to generate unit tests for this PR.
• @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 or @coderabbitai title 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.