Baseline Widely available
Note: This feature is available in Web Workers.
The postMessage()
method of the MessagePort
interface sends a message from the port, and optionally, transfers ownership of objects to other browsing contexts.
postMessage(message)
postMessage(message, transfer)
postMessage(message, options)
Parameters
message
The message you want to send through the channel. This can be of any basic data type. Multiple data items can be sent as an array.
transfer
Optional
An optional array of transferable objects to transfer ownership of. The ownership of these objects is given to the destination side and they are no longer usable on the sending side. These transferable objects should be attached to the message; otherwise they would be moved but not actually accessible on the receiving end.
options
Optional
An optional object containing the following properties:
transfer
Optional
Has the same meaning as the transfer
parameter.
None (undefined
).
In the following code block, you can see a new channel being created using the MessageChannel()
constructor. When the IFrame has loaded, we pass MessageChannel.port2
to the IFrame using window.postMessage
along with a message. The iframe receives the message, and sends a message back on the MessageChannel
using postMessage()
. The handleMessage
handler then responds to a message being sent back from the iframe using onmessage
, putting it into a paragraph â MessageChannel.port1
is listened to, to check when the message arrives.
const channel = new MessageChannel();
const para = document.querySelector("p");
const ifr = document.querySelector("iframe");
const otherWindow = ifr.contentWindow;
ifr.addEventListener("load", iframeLoaded, false);
function iframeLoaded() {
otherWindow.postMessage("Transferring message port", "*", [channel.port2]);
}
channel.port1.onmessage = handleMessage;
function handleMessage(e) {
para.innerHTML = e.data;
}
// in the iframeâ¦
window.addEventListener("message", (event) => {
const messagePort = event.ports?.[0];
messagePort.postMessage("Hello from the iframe!");
});
For a full working example, see our channel messaging basic demo on GitHub (run it live too).
Specifications Browser compatibility See alsoRetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.3