Back to Content

MessageChannel: port1 property

files/en-us/web/api/messagechannel/port1/index.md

latest1.6 KB
Original Source

{{APIRef("Channel Messaging API")}} {{AvailableInWorkers}}

The port1 read-only property of the {{domxref("MessageChannel")}} interface returns the first port of the message channel — the port attached to the context that originated the channel.

Value

A {{domxref("MessagePort")}} object, the first port of the channel, that is the port attached to the context that originated the channel.

Examples

In the following code block, you can see a new channel being created using the {{domxref("MessageChannel.MessageChannel", "MessageChannel()")}} constructor. When the {{HTMLElement("iframe")}} has loaded, we pass {{domxref("MessageChannel.port2", "port2")}} to the {{HTMLElement("iframe")}} using {{domxref("MessagePort.postMessage")}} along with a message. The handleMessage handler then responds to a message being sent back from the <iframe> (using {{domxref("MessagePort.message_event", "onmessage")}}), putting it into a paragraph. The handleMessage method is associated to the port1 to listen when the message arrives.

js
const channel = new MessageChannel();
const para = document.querySelector("p");

const ifr = document.querySelector("iframe");
const otherWindow = ifr.contentWindow;

ifr.addEventListener("load", iframeLoaded);

function iframeLoaded() {
  otherWindow.postMessage("Hello from the main page!", "*", [channel.port2]);
}

channel.port1.onmessage = handleMessage;
function handleMessage(e) {
  para.innerHTML = e.data;
}

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also