function receiveMessageOnPort
Usage in Deno
import { receiveMessageOnPort } from "node:worker_threads";
receiveMessageOnPort(port: MessagePort): { message: any; } | undefined
<div class="alert alert-warning"><div><svg xmlns="http://www.w3.org/2000/svg" width="14" height="14"
viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2"
stroke-linecap="round" stroke-linejoin="round">
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
<path d="M12 9v4" />
<path
d="M10.363 3.591l-8.106 13.534a1.914 1.914 0 0 0 1.636 2.871h16.214a1.914 1.914 0 0 0 1.636 -2.87l-8.106 -13.536a1.914 1.914 0 0 0 -3.274 0z" />
<path d="M12 16h.01" />
</svg>
Deno compatibility</div><div><p>
This symbol is not supported.</p>
</div></div>
Receive a single message from a given MessagePort
. If no message is available,undefined
is returned, otherwise an object with a single message
property
that contains the message payload, corresponding to the oldest message in the MessagePort
's queue.
import { MessageChannel, receiveMessageOnPort } from 'node:worker_threads'; const { port1, port2 } = new MessageChannel(); port1.postMessage({ hello: 'world' }); console.log(receiveMessageOnPort(port2)); // Prints: { message: { hello: 'world' } } console.log(receiveMessageOnPort(port2)); // Prints: undefined
When this function is used, no 'message'
event is emitted and the onmessage
listener is not invoked.
port: MessagePort
{ message: any; } | undefined