Skip to content

Commit 9dc5285

Browse files
committed
fixup
Signed-off-by: Matteo Collina <hello@matteocollina.com>
1 parent 65cd34e commit 9dc5285

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

doc/api/worker_threads.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1536,11 +1536,12 @@ added: REPLACEME
15361536
* `buffer` {SharedArrayBuffer} A shared memory buffer to use for communication.
15371537
* `options` {Object}
15381538
* `timeout` {number} The timeout in milliseconds for synchronous calls. **Default:** `5000`.
1539-
* `expandable` {boolean} Whether the buffer can be resized. **Default:** `true` if the buffer supports `growable` option.
1540-
* Returns: {Object} An object with synchronous methods mirroring those exposed through `wire()`.
1539+
* `expandable` {boolean} Whether the buffer can be resized. **Default:** `true` if the buffer
1540+
supports `growable` option.
1541+
* Returns: {Object} An object with synchronous methods mirroring those exposed through [`worker.wire()`][].
15411542

15421543
Creates a synchronous API facade that communicates with a worker thread over a shared memory buffer.
1543-
The worker thread must call `wire()` on the same buffer to register the methods that can be called.
1544+
The worker thread must call [`worker.wire()`][] on the same buffer to register the methods that can be called.
15441545

15451546
This function enables making synchronous calls to a worker thread, which is particularly useful
15461547
when code requires blocking operations but still wants to benefit from the worker thread's isolation.
@@ -1574,7 +1575,7 @@ added: REPLACEME
15741575
* `buffer` {SharedArrayBuffer} A shared memory buffer to use for communication.
15751576
* `methods` {Object} An object whose properties are methods to expose to the main thread.
15761577
1577-
Exposes methods to the main thread that can be called synchronously using `makeSync()`.
1578+
Exposes methods to the main thread that can be called synchronously using [`worker.makeSync()`][].
15781579
The methods can be async functions or return promises, and the main thread will wait
15791580
for the promise to resolve or reject.
15801581
@@ -1705,11 +1706,11 @@ thread spawned will spawn another until the application crashes.
17051706
[`v8.getHeapSnapshot()`]: v8.md#v8getheapsnapshotoptions
17061707
[`vm`]: vm.md
17071708
[`worker.SHARE_ENV`]: #workershare_env
1709+
[`worker.makeSync()`]: #workermakesyncbuffer-options
17081710
[`worker.on('message')`]: #event-message_1
17091711
[`worker.postMessage()`]: #workerpostmessagevalue-transferlist
17101712
[`worker.terminate()`]: #workerterminate
17111713
[`worker.threadId`]: #workerthreadid_1
1712-
[`worker.makeSync()`]: #workermakesyncbuffer-options
17131714
[`worker.wire()`]: #workerwirebuffer-methods
17141715
[async-resource-worker-pool]: async_context.md#using-asyncresource-for-a-worker-thread-pool
17151716
[browser `MessagePort`]: https://developer.mozilla.org/en-US/docs/Web/API/MessagePort

0 commit comments

Comments
 (0)