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
WHATWG HTML Living Standard
The definition of 'close()' in that specification.
Living Standard No difference from HTML5 Web Messaging.
HTML5 Web Messaging
The definition of 'close()' in that specification.
Recommendation W3C version of the spec

Browser compatibility

Feature Chrome Edge Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support 4 (Yes) (Yes) 10.0 10.6 5
Available in workers (Yes) ? 41 (41) (Yes) (Yes) (Yes)
Feature Android Chrome for Android Edge Firefox Mobile (Gecko) Firefox OS (Gecko) IE Phone Opera Mobile Safari Mobile
Basic support 4.4 4 (Yes) No support No support 10.0 11.5 5.1
Available in workers (Yes) (Yes) ? 41.0 (41) (Yes) (Yes) (Yes) (Yes)

See also

Document Tags and Contributors

 Contributors to this page: stevenwdv, nmve, libbymc, Sebastianz, chrisdavidmills, fscholz, kscarfone
 Last updated by: stevenwdv,