Improve type consistency

[w01fgang]

This PR aims to improve type consistency across the codebase.

Summary by CodeRabbit

• New Features
  • Improved TypeScript typings for the default method, ensuring that after providing a default value, the value() method will always return a defined result.
• Tests
  • Added a new test to verify type safety and consistent runtime behavior when using the default method with error handling.
• Chores
  • Added a new npm script for TypeScript type checking without emitting files.

[coderabbitai]

Walkthrough

A new test case was added to the Try test suite to validate type safety and runtime behavior when using the default method. The default method in the Try class was updated to provide a more precise TypeScript return type, ensuring that the value() method reflects the presence of a guaranteed default value. Additionally, the package version was bumped and a type checking script was added.

Changes

File(s)	Change Summary
src/tests/Try.test.ts	Added a test case to verify type safety and runtime behavior with the default method and default values.
src/nextjs/index.ts	Updated the default method in the Try class to refine its TypeScript return type for improved type accuracy.
package.json	Bumped package version from 0.0.5 to 0.0.6; added a new npm script typecheck to run TypeScript compiler in noEmit mode.

Poem

In the warren of code, a new test appears,
Ensuring that types bring no bunny tears.
The default method now hops with more grace,
Its promise of safety, no bugs to chase.
With every return, a value in sight—
TypeScript and rabbits both sleep well at night! 🐇

---

📜 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 4978291 and 928412c.

📒 Files selected for processing (1)

• package.json (2 hunks)

✅ Files skipped from review due to trivial changes (1)

• package.json

✨ Finishing Touches

🧪 Generate Unit Tests

• Create PR with Unit Tests
• Post Copyable Unit Tests in Comment
• Commit Unit Tests in branch improve-type-consistency

---

🪧 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

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

220-230: Consider a more descriptive test name.

The test logic is excellent and thoroughly validates both the type safety and runtime behavior of the enhanced default method. However, the test name "should not give typescript error" could be more specific about what it's testing.

Consider renaming to something more descriptive like:

-  it('should not give typescript error', async () => {
+  it('should guarantee non-undefined result when default value is provided', async () => {

This better describes the specific TypeScript enhancement being validated - that the value() method's return type excludes undefined after calling default().

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 11c544d and 4978291.

📒 Files selected for processing (2)

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

🧰 Additional context used

🧬 Code Graph Analysis (1)

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

src/nextjs/index.ts (1)

• Try (33-446)

🔇 Additional comments (1)

src/nextjs/index.ts (1)

205-213: Excellent type safety enhancement!

This is a well-designed improvement that leverages TypeScript's advanced type system to provide better compile-time guarantees. The use of Omit and intersection types ensures that after calling default(), the value() method's return type correctly excludes undefined, making the API more type-safe without affecting runtime behavior.

The implementation correctly:

• Preserves all other methods while only narrowing the value() return type
• Uses a safe type assertion since the runtime shape remains unchanged
• Provides clear documentation about the type-only nature of the change