feat: add async option #371
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
commit: |
size-limit report 📦
|
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds support for explicitly setting the async option for benchmark tasks in Tinybench. This allows users to override the automatic async detection behavior, which is useful when a function returns a Promise but should be treated as synchronous (e.g., for API compatibility), or vice versa.
Key Changes:
- Added an optional
asyncboolean field to theFnOptionsinterface - Updated the
Taskconstructor to respect the explicitasyncoption when provided, falling back to automatic detection otherwise - Added comprehensive documentation explaining async detection behavior and how to use the new option
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/types.ts | Added async optional field to FnOptions interface with documentation |
| src/task.ts | Modified Task constructor to use explicit async option when provided, falling back to isFnAsyncResource() |
| README.md | Added "Async Detection" section with detailed explanation and usage examples |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
fix #370