MessagePort: close() method
Baseline Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since September 2015.
Note: This feature is available in Web Workers.
The close()
method of the MessagePort
interface disconnects the port, so it is no longer active. This stops the flow of
messages to that port.
Syntax
js
close()
Parameters
None.
Return value
None (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
EventTarget.addEventListener
.
js
channel.port1.addEventListener("message", handleMessage, false);
function handleMessage(e) {
para.innerHTML = e.data;
textInput.value = "";
}
channel.port1.start();
You could stop messages being sent at any time using
js
channel.port1.close();
Specifications
Specification |
---|
HTML Standard # dom-messageport-close-dev |
Browser compatibility
BCD tables only load in the browser