add docs for new async check function in k6-utils #1694
Merged
Conversation
This file contains 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
Comment on lines
3
to
4
| description: 'Runs one or more checks on a value and generates a pass/fail result but does not throw errors or otherwise interrupt execution upon failure.' | ||
| description: 'Runs one or more checks on a value and generates a pass/fail result but does not throw errors or otherwise interrupt execution upon failure.' |
There was a problem hiding this comment.
Suggested change
| description: 'Runs one or more checks on a value and generates a pass/fail result but does not throw errors or otherwise interrupt execution upon failure.' | |
| description: 'Runs one or more checks on a value and generates a pass/fail result but does not throw errors or otherwise interrupt execution upon failure.' | |
| description: 'The jslib check function runs one or more checks on a value and generates a pass/fail result, but does not throw errors or interrupt test execution upon failure. It supports async values.' |
Removing the duplicate description, and some small edits to it. I think it's useful for us to add the async support here.
|
|
||
| # check( val, sets, [tags] ) | ||
|
|
||
| This is a drop-in replacement for the built-in [check](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6/check/) with support for async values. Any `Promise`s will be awaited and the result will be reported once the operation has completed. |
There was a problem hiding this comment.
Suggested change
| This is a drop-in replacement for the built-in [check](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6/check/) with support for async values. Any `Promise`s will be awaited and the result will be reported once the operation has completed. | |
| The `check` function is a drop-in replacement for the built-in [check](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6/check/), with added support for async values. Any `Promise`s will be awaited, and the result is reported once the operation has been completed. |
| | Parameter | Type | Description | | ||
| | --------------- | ---------------------- | ---------------------------------------------------------------------------------------- | | ||
| | val | any | Value to test. | | ||
| | sets | Record<string, any> | Tests (checks) to run on the value. Functions will be called. `Promise`s will be awaited | |
There was a problem hiding this comment.
Suggested change
| | sets | Record<string, any> | Tests (checks) to run on the value. Functions will be called. `Promise`s will be awaited | | |
| | sets | Record<string, any> | Tests (checks) to run on the value. Functions will be called. `Promise`s will be awaited. | |
|
|
||
| | Type | Description | | ||
| | ---------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | | ||
| | Promise<boolean> | boolean | `true` if all checks have succeeded, `false` otherwise. If any of the checked values was a `Promise`, the result will be wrapped in a `Promise`. | |
There was a problem hiding this comment.
Suggested change
| | Promise<boolean> | boolean | `true` if all checks have succeeded, `false` otherwise. If any of the checked values was a `Promise`, the result will be wrapped in a `Promise`. | | |
| | Promise<boolean> | boolean | `true` if all checks have succeeded, `false` otherwise. If any of the checked values was a `Promise`, the result is wrapped in a `Promise`. | |
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.
What?
This PR documents the new async check function in k6-utils.
Checklist
npm startcommand locally and verified that the changes look good.docs/sources/nextfolder of the documentation.docs/sources/v{most_recent_release}folder of the documentation.Related PR(s)/Issue(s)
Issue: grafana/jslib.k6.io#125