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.

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

See also

• Using channel messaging