Skip to content

doc: add missing return types in cluster.md - #66453

Open
Cayan wants to merge 1 commit into
nodejs:mainfrom
Cayan:doc-cluster-worker-returns
Open

Cayan wants to merge 1 commit into
nodejs:mainfrom
Cayan:doc-cluster-worker-returns

Conversation

@Cayan

@Cayan Cayan commented Oct 2, 2026

Copy link
Copy Markdown

worker.isConnected() and worker.isDead() describe their boolean result only in prose, so the doc tooling has no return type for them. This adds * Returns: {boolean} to both, the same way #65307 did for fs.md.

Both return this.process.connected and an exit/signal check (lib/internal/cluster/worker.js). I checked on v24 that they return true/false while the worker runs and false/true after it exits.

Written with AI assistance (see the Assisted-by trailer); I reviewed the change and ran the check above myself.

@nodejs-github-bot nodejs-github-bot added cluster Issues and PRs related to the cluster subsystem. doc Issues and PRs related to Node.js documentation. labels Oct 2, 2026
@github-actions

github-actions Bot commented Oct 2, 2026

Copy link
Copy Markdown
Contributor

Welcome to Node.js, and thank you for your first contribution!

Before review, please take a moment to read:

Please make sure every commit is signed off. For a first pull request, GitHub Actions require collaborator approval and Jenkins CI must be started by a collaborator or triager, so an initial wait is normal.

Caution

AgentScan found account activity patterns that may be consistent with automation. This is a heuristic, not proof that this pull request was opened by an agent or violates policy. AI-assisted contributions are permitted, but automated tooling must not open pull requests without advance approval, and contributors must personally understand, test, verify, and take responsibility for every submitted change. See the AgentScan analysis, AI use policy, and automation policy for additional context.

`worker.isConnected()` and `worker.isDead()` described their boolean
result only in prose, so the documentation tooling had no return type
for them.

Signed-off-by: Daniel Pinto <1619617+Cayan@users.noreply.github.com>
Assisted-by: a frontier reasoning model
@Cayan
Cayan force-pushed the doc-cluster-worker-returns branch from 4bcb458 to 214e3dc Compare October 2, 2026 02:31
@Renegade334 Renegade334 added author ready PRs with CI started, the required approvals, and no outstanding review comments. commit-queue PRs queued for automated landing through the Commit Queue. labels Oct 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

agentscan:automated-account author ready PRs with CI started, the required approvals, and no outstanding review comments. cluster Issues and PRs related to the cluster subsystem. commit-queue PRs queued for automated landing through the Commit Queue. doc Issues and PRs related to Node.js documentation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants