tyler.durden
/
test262
mirror of https://github.com/tc39/test262.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

CONTRIBUTING.md: Improve asyncHelpers documentation 

* Only mention `$DONE` after `asyncTest`.
* Document that `asyncTest` is not intended to be called multiple times per file.
This commit is contained in:
Richard Gibson 2024-05-19 12:43:11 -04:00
parent 5492929d55
commit 8ca5bdd44c
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
CONTRIBUTING.md
View File

@ -209,8 +209,9 @@ This key is for boolean properties associated with the test.
- **raw** - execute the test without any modification (no harness files will be - **raw** - execute the test without any modification (no harness files will be
included); necessary to test the behavior of directive prologue; implies included); necessary to test the behavior of directive prologue; implies
`noStrict` `noStrict`
- **async** - defer interpretation of test results until after the invocation - **async** - defer interpretation of test results until settlement of an
of the global `$DONE` function `asyncTest` callback promise or manual invocation of `$DONE`; refer to
[Writing Asynchronous Tests](#writing-asynchronous-tests) for details
- **generated** - informative flag used to denote test files that were - **generated** - informative flag used to denote test files that were
created procedurally using the project's test generation tool; refer to created procedurally using the project's test generation tool; refer to
[Procedurally-generated tests](#procedurally-generated-tests) [Procedurally-generated tests](#procedurally-generated-tests)
@ -346,7 +347,7 @@ Consumers that violate the spec by throwing exceptions for parsing errors at run
An asynchronous test is any test that include the `async` frontmatter flag. An asynchronous test is any test that include the `async` frontmatter flag.
For most asynchronous tests, the `asyncHelpers.js` harness file includes an `asyncTest` method that precludes needing to interact with the test runner via the `$DONE` function. `asyncTest` takes an async function and will ensure that `$DONE` is called properly if the async function returns or throws an exception. For example, a test written using `asyncTest` might look like: Most asynchronous tests should include the `asyncHelpers.js` harness file and call its `asyncTest` function **exactly once**, with a callback returning a promise that indicates test failure via rejection and otherwise fulfills upon test conclusion (such as an async function).
```js ```js
/*--- /*---