Skip to content

Commit bc31375

Browse files
pulkit-30RafaelGSS
authored andcommitted
doc: shard not supported with watch mode
PR-URL: #50640 Reviewed-By: Raz Luvaton <[email protected]> Reviewed-By: Moshe Atlow <[email protected]>
1 parent 9dc4cde commit bc31375

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

doc/api/test.md

+5
Original file line numberDiff line numberDiff line change
@@ -1142,6 +1142,11 @@ changes:
11421142
of shards to split the test files to. This option is _required_.
11431143
* Returns: {TestsStream}
11441144

1145+
**Note:** `shard` is used to horizontally parallelize test running across
1146+
machines or processes, ideal for large-scale executions across varied
1147+
environments. It's incompatible with `watch` mode, tailored for rapid
1148+
code iteration by automatically rerunning tests on file changes.
1149+
11451150
```mjs
11461151
import { tap } from 'node:test/reporters';
11471152
import { run } from 'node:test';

0 commit comments

Comments
 (0)