Skip to content

Commit bd24516

Browse files
committed
worker: clarify API stability
1 parent 1ac4bfe commit bd24516

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

doc/api/worker_threads.md

+6
Original file line numberDiff line numberDiff line change
@@ -67,13 +67,17 @@ specifically `argv` and `execArgv` options.
6767
added: REPLACEME
6868
-->
6969

70+
> Stability: 1.1 - Active development
71+
7072
* `target` {number} The target thread id.
7173
* `data` {any} Any arbitrary, cloneable JavaScript value.
7274
* Returns: {MessagePort}
7375

7476
Establishes a connection to another worker thread in the same process, returning a
7577
`MessagePort` that can be used for the communication.
7678

79+
The thread will be blocked while waiting for the port from the other thread.
80+
7781
The target thread must have a connection listener setup via [`worker.setConnectionsListener()`][]
7882
otherwise the connection request will fail.
7983

@@ -347,6 +351,8 @@ new Worker('process.env.SET_IN_WORKER = "foo"', { eval: true, env: SHARE_ENV })
347351
added: REPLACEME
348352
-->
349353

354+
> Stability: 1.1 - Active development
355+
350356
* `fn` {Function} A callback to be executed when [`worker.connect()`][] is called from another thread.
351357
The function will received the following arguments:
352358

0 commit comments

Comments
 (0)