Skip to content

docs: update README #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aduh95 merged 1 commit into from
Jun 2, 2022
Merged

docs: update README #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 5 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,27 +8,21 @@ available in Node.js 14 and later.

Minimal dependencies, with full test suite.

If we discover bugs in this implementation, I'm going to report them back to
node core.

Differences from the core implementation:

- Doesn't hide its own stack frames
- Doesn't hide its own stack frames.

## Docs

> https://github.com/nodejs/node/blob/adaf60240559ffb58636130950262ee3237b7a41/doc/api/test.md

# Test runner

<!--introduced_in=REPLACEME-->
### Test runner

> Stability: 1 - Experimental

<!-- source_link=lib/test.js -->

The `node:test` module facilitates the creation of JavaScript tests that
report results in [TAP][] format. To access it:
report results in [TAP][] format. This package is a port of `node:test`.
To access it:

```mjs
import test from 'test'
Expand Down Expand Up @@ -105,7 +99,7 @@ As a test file executes, TAP is written to the standard output of the Node.js
process. This output can be interpreted by any test harness that understands
the TAP format. If any tests fail, the process exit code is set to `1`.

## Subtests
#### Subtests

The test context's `test()` method allows subtests to be created. This method
behaves identically to the top level `test()` function. The following example
Expand Down Expand Up @@ -414,11 +408,6 @@ behaves in the same fashion as the top level [`test()`][] function.
[`test()`]: #testname-options-fn
[test runner execution model]: #test-runner-execution-model

## Kudos

Thank you [@aduh95](https://github.com/aduh95) for sharing the new `node:test`
module in the [@transloadit](https://github.com/transloadit) Slack.

## License

MIT