MessagePort.close()

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.

Note: This feature is available in Web Workers.

Syntax

port.close()

Returns

Void.

Parameters

None.

Example

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.

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

channel.port1.close();

Specifications

Specification Status Comment
HTML Living Standard
The definition of 'close()' in that specification.
Living Standard  

Browser compatibility

FeatureChromeEdgeFirefoxInternet ExplorerOperaSafari
Basic support4 Yes Yes1010.65
FeatureAndroid webviewChrome for AndroidEdge mobileFirefox for AndroidOpera AndroidiOS SafariSamsung Internet
Basic support Yes18 Yes No11.55.1 ?

See also

Document Tags and Contributors

Last updated by: fscholz,