function receiveMessageOnPort
Usage in Deno
import { receiveMessageOnPort } from "node:worker_threads";
receiveMessageOnPort(port: MessagePort): { message: any; } | undefined
Deno compatibility
This symbol is not supported.
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