Skip to content

Commit 0a3c7f1

Browse files
authored
doc: add missing return types in cluster.md
`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 PR-URL: #66453 Reviewed-By: René <contact.9a5d6388@renegade334.me.uk> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
1 parent c60762c commit 0a3c7f1

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

‎doc/api/cluster.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -489,6 +489,8 @@ While a worker is alive, this is the key that indexes it in
489489
added: v0.11.14
490490
-->
491491

492+
* Returns: {boolean}
493+
492494
This function returns `true` if the worker is connected to its primary via its
493495
IPC channel, `false` otherwise. A worker is connected to its primary after it
494496
has been created. It is disconnected after the `'disconnect'` event is emitted.
@@ -499,6 +501,8 @@ has been created. It is disconnected after the `'disconnect'` event is emitted.
499501
added: v0.11.14
500502
-->
501503

504+
* Returns: {boolean}
505+
502506
This function returns `true` if the worker's process has terminated (either
503507
because of exiting or being signaled). Otherwise, it returns `false`.
504508

0 commit comments

Comments
 (0)