happy-dom/src/event/IMessagePort.ts

Happy DOM is a JavaScript implementation of a web browser without its graphical user interface. It includes many web standards from WHATWG DOM and HTML.

import EventTarget from './EventTarget.js';

/**
 * Message port.
 *
 * @see https://developer.mozilla.org/en-US/docs/Web/API/MessagePort
 */
export default interface IMessagePort extends EventTarget {
	/**
	 * Sends a message from the port, and optionally, transfers ownership of objects to other browsing contexts.
	 *
	 * @param type Event type.
	 * @param listener Listener.
	 */
	postMessage(message: unknown, transerList: unknown[]): void;

	/**
	 * Starts the sending of messages queued on the port.
	 */
	start(): void;

	/**
	 * Disconnects the port, so it is no longer active. This stops the flow of messages to that port.
	 */
	close(): void;
}