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

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidEdge MobileFirefox for AndroidOpera for AndroidiOS SafariSamsung Internet
Basic supportChrome Full support 4Edge Full support YesFirefox Full support YesIE Full support 10Opera Full support 10.6Safari Full support 5WebView Android Full support YesChrome Android Full support 18Edge Mobile Full support YesFirefox Android No support NoOpera Android Full support 11.5Safari iOS Full support 5.1Samsung Internet Android ?

Legend

Full support  
Full support
No support  
No support
Compatibility unknown  
Compatibility unknown

See also

Document Tags and Contributors

Last updated by: fscholz,