From b852483e1536bf6be82072f0d544613ab052f99a Mon Sep 17 00:00:00 2001 From: pulkit-30 Date: Mon, 20 Nov 2023 22:14:03 +0530 Subject: [PATCH] doc: shard not supported with watch mode --- doc/api/test.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc/api/test.md b/doc/api/test.md index ea7c90e4ad9d63..4b444e2effb218 100644 --- a/doc/api/test.md +++ b/doc/api/test.md @@ -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';