MessagePort: close() method

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

The close() method of the {{domxref("MessagePort")}} interface disconnects the port, so it is no longer active. This stops the flow of messages to that port.

Syntax

close()

Parameters

None.

Return value

None ({{jsxref("undefined")}}).

Examples

In the following code block, you can see a handleMessage handler function, run when a message is sent back to this document using {{domxref("EventTarget.addEventListener")}}.

channel.port1.addEventListener("message", handleMessage);
function handleMessage(e) {
  para.innerHTML = e.data;
  textInput.value = "";
}

channel.port1.start();

You could stop messages being sent at any time using

channel.port1.close();

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

• Using channel messaging