Skip to content

Commit

Permalink
docs: shard not supported with watch mode
Browse files Browse the repository at this point in the history
  • Loading branch information
pulkit-30 committed Nov 20, 2023
1 parent 5b73da0 commit 63742cf
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions doc/api/test.md
Original file line number Diff line number Diff line change
Expand Up @@ -1142,6 +1142,11 @@ changes:
of shards to split the test files to. This option is _required_.
* Returns: {TestsStream}

**Note:** `shard` is used to horizontally parallelize test running across
machines or processes, ideal for large-scale executions across varied
environments. It's incompatible with `watch` mode, tailored for rapid
code iteration by automatically rerunning tests on file changes.

```mjs
import { tap } from 'node:test/reporters';
import { run } from 'node:test';
Expand Down

0 comments on commit 63742cf

Please sign in to comment.