added periodic stopwatch return

[joshika39]

Summary by CodeRabbit

• New Features
  • Enhanced the stopwatch functionality to include more flexible operation controls.

[coderabbitai]

Walkthrough

The recent updates involve enhancing the flexibility of the PeriodicOperation method in the IStopwatch interface and its implementation. The method now supports an optional CancellationToken and returns an IPeriodicStopwatch. This change allows for easier integration and control over periodic operations in time-sensitive applications.

Changes

File Path	Change Summary
.../Time/DefaultStopwatch.cs	Added an overloaded version of PeriodicOperation with a default CancellationToken.
.../Time/IStopwatch.cs	Modified PeriodicOperation to return IPeriodicStopwatch and added an overload without CancellationToken.

🐇✨
A hop through time, a tick and a tock,
A method refined, on the code block rock.
No token required, or use it you might,
For timing's essence captured just right.
Cheers to the changes, oh so bright! 🎉
🐇✨

---

Recent Review Details

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 749df72 and fe4f67c.

Files selected for processing (2)

• _src/Implementation/Time/DefaultStopwatch.cs (1 hunks)
• _src/Infrastructure/Time/IStopwatch.cs (1 hunks)

Files not reviewed due to errors (1)

• (no review received)

Additional comments not posted (2)

_src/Infrastructure/Time/IStopwatch.cs (2)

13-13: Change to return IPeriodicStopwatch enhances flexibility and abstraction.

---

14-14: Addition of overload without CancellationToken simplifies API usage.

---

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.