happy-dom 5.4.0 → 6.0.0

package/src/dom-parser/DOMParser.ts

@@ -1,10 +1,11 @@
-import Document from '../nodes/document/Document';
+import IDocument from '../nodes/document/IDocument';
 import XMLParser from '../xml-parser/XMLParser';
 import Node from '../nodes/node/Node';
 import DOMException from '../exception/DOMException';
 import HTMLDocument from '../nodes/html-document/HTMLDocument';
 import XMLDocument from '../nodes/xml-document/XMLDocument';
 import SVGDocument from '../nodes/svg-document/SVGDocument';
+import IWindow from '../window/IWindow';
 
 /**
  * DOM parser.
@@ -13,7 +14,16 @@ import SVGDocument from '../nodes/svg-document/SVGDocument';
  * https://developer.mozilla.org/en-US/docs/Web/API/DOMParser.
  */
 export default class DOMParser {
-	public static _ownerDocument: Document = null;
+	// Owner document is set by a sub-class in the Window constructor
+	public static _ownerDocument: IDocument = null;
+	public readonly _ownerDocument: IDocument = null;
+
+	/**
+	 * Constructor.
+	 */
+	constructor() {
+		this._ownerDocument = (<typeof DOMParser>this.constructor)._ownerDocument;
+	}
 
 	/**
 	 * Parses HTML and returns a root element.
@@ -22,15 +32,15 @@ export default class DOMParser {
 	 * @param mimeType Mime type.
 	 * @returns Root element.
 	 */
-	public parseFromString(string: string, mimeType: string): Document {
+	public parseFromString(string: string, mimeType: string): IDocument {
 		if (!mimeType) {
 			throw new DOMException('Second parameter "mimeType" is mandatory.');
 		}
 
-		const ownerDocument = (<typeof DOMParser>(<unknown>this.constructor))._ownerDocument;
+		const ownerDocument = this._ownerDocument;
 		const newDocument = this._createDocument(mimeType);
 
-		newDocument.defaultView = ownerDocument.defaultView;
+		(<IWindow>newDocument.defaultView) = ownerDocument.defaultView;
 		newDocument.childNodes.length = 0;
 		newDocument.children.length = 0;
 
@@ -81,17 +91,20 @@ export default class DOMParser {
 	/**
 	 *
 	 * @param mimeType Mime type.
-	 * @returns Document.
+	 * @returns IDocument.
 	 */
-	private _createDocument(mimeType: string): Document {
+	private _createDocument(mimeType: string): IDocument {
 		switch (mimeType) {
 			case 'text/html':
+				HTMLDocument._defaultView = this._ownerDocument.defaultView;
 				return new HTMLDocument();
 			case 'image/svg+xml':
+				SVGDocument._defaultView = this._ownerDocument.defaultView;
 				return new SVGDocument();
 			case 'text/xml':
 			case 'application/xml':
 			case 'application/xhtml+xml':
+				XMLDocument._defaultView = this._ownerDocument.defaultView;
 				return new XMLDocument();
 			default:
 				throw new DOMException(`Unknown mime type "${mimeType}".`);

package/src/exception/DOMExceptionNameEnum.ts

@@ -3,6 +3,10 @@ enum DOMExceptionNameEnum {
 	indexSizeError = 'IndexSizeError',
 	syntaxError = 'SyntaxError',
 	hierarchyRequestError = 'HierarchyRequestError',
-	invalidCharacterError = 'InvalidCharacterError'
+	notSupportedError = 'NotSupportedError',
+	wrongDocumentError = 'WrongDocumentError',
+	invalidNodeTypeError = 'InvalidNodeTypeError',
+	invalidCharacterError = 'InvalidCharacterError',
+	notFoundError = 'NotFoundError'
 }
 export default DOMExceptionNameEnum;

package/src/fetch/Request.ts

@@ -7,7 +7,20 @@ import IDocument from '../nodes/document/IDocument';
  * Fetch request.
  */
 export default class Request extends NodeFetch.Request implements IRequest {
+	// Owner document is set by a sub-class in the Window constructor
 	public static _ownerDocument: IDocument = null;
+	public readonly _ownerDocument: IDocument = null;
+
+	/**
+	 * Constructor.
+	 *
+	 * @param input Input.
+	 * @param [init] Init.
+	 */
+	constructor(input: NodeFetch.RequestInfo, init?: NodeFetch.RequestInit) {
+		super(input, init);
+		this._ownerDocument = (<typeof Request>this.constructor)._ownerDocument;
+	}
 
 	/**
 	 * Returns array buffer.
@@ -105,8 +118,7 @@ export default class Request extends NodeFetch.Request implements IRequest {
 	 * @returns Task ID.
 	 */
 	private _handlePromiseStart(): number {
-		const taskManager = (<typeof Request>this.constructor)._ownerDocument.defaultView.happyDOM
-			.asyncTaskManager;
+		const taskManager = this._ownerDocument.defaultView.happyDOM.asyncTaskManager;
 		return taskManager.startTask();
 	}
 
@@ -124,8 +136,7 @@ export default class Request extends NodeFetch.Request implements IRequest {
 		taskID: number,
 		response: unknown
 	): void {
-		const taskManager = (<typeof Request>this.constructor)._ownerDocument.defaultView.happyDOM
-			.asyncTaskManager;
+		const taskManager = this._ownerDocument.defaultView.happyDOM.asyncTaskManager;
 		if (taskManager.getTaskCount() === 0) {
 			reject(new Error('Failed to complete fetch request. Task was canceled.'));
 		} else {
@@ -141,8 +152,7 @@ export default class Request extends NodeFetch.Request implements IRequest {
 	 * @param reject
 	 */
 	private _handlePromiseError(reject: (error: Error) => void, error: Error): void {
-		const taskManager = (<typeof Request>this.constructor)._ownerDocument.defaultView.happyDOM
-			.asyncTaskManager;
+		const taskManager = this._ownerDocument.defaultView.happyDOM.asyncTaskManager;
 		reject(error);
 		taskManager.cancelAll(error);
 	}

package/src/fetch/Response.ts

@@ -7,7 +7,17 @@ import * as NodeFetch from 'node-fetch';
  * Fetch response.
  */
 export default class Response extends NodeFetch.Response implements IResponse {
+	// Owner document is set by a sub-class in the Window constructor
 	public static _ownerDocument: IDocument = null;
+	public readonly _ownerDocument: IDocument = null;
+
+	/**
+	 * Constructor.
+	 */
+	constructor() {
+		super();
+		this._ownerDocument = (<typeof Response>this.constructor)._ownerDocument;
+	}
 
 	/**
 	 * Returns array buffer.
@@ -105,8 +115,7 @@ export default class Response extends NodeFetch.Response implements IResponse {
 	 * @returns Task ID.
 	 */
 	private _handlePromiseStart(): number {
-		const taskManager = (<typeof Response>this.constructor)._ownerDocument.defaultView.happyDOM
-			.asyncTaskManager;
+		const taskManager = this._ownerDocument.defaultView.happyDOM.asyncTaskManager;
 		return taskManager.startTask();
 	}
 
@@ -124,8 +133,7 @@ export default class Response extends NodeFetch.Response implements IResponse {
 		taskID: number,
 		response: unknown
 	): void {
-		const taskManager = (<typeof Response>this.constructor)._ownerDocument.defaultView.happyDOM
-			.asyncTaskManager;
+		const taskManager = this._ownerDocument.defaultView.happyDOM.asyncTaskManager;
 		if (taskManager.getTaskCount() === 0) {
 			reject(new Error('Failed to complete fetch request. Task was canceled.'));
 		} else {
@@ -141,8 +149,7 @@ export default class Response extends NodeFetch.Response implements IResponse {
 	 * @param reject
 	 */
 	private _handlePromiseError(reject: (error: Error) => void, error: Error): void {
-		const taskManager = (<typeof Response>this.constructor)._ownerDocument.defaultView.happyDOM
-			.asyncTaskManager;
+		const taskManager = this._ownerDocument.defaultView.happyDOM.asyncTaskManager;
 		reject(error);
 		taskManager.cancelAll(error);
 	}

package/src/file/FileReader.ts

@@ -1,6 +1,6 @@
 import WhatwgMIMEType from 'whatwg-mimetype';
 import WhatwgEncoding from 'whatwg-encoding';
-import Document from '../nodes/document/Document';
+import IDocument from '../nodes/document/IDocument';
 import ProgressEvent from '../event/events/ProgressEvent';
 import DOMException from '../exception/DOMException';
 import DOMExceptionNameEnum from '../exception/DOMExceptionNameEnum';
@@ -18,7 +18,8 @@ import FileReaderEventTypeEnum from './FileReaderEventTypeEnum';
  * https://github.com/jsdom/jsdom/blob/master/lib/jsdom/living/file-api/FileReader-impl.js (MIT licensed).
  */
 export default class FileReader extends EventTarget {
-	public static _ownerDocument: Document = null;
+	// Owner document is set by a sub-class in the Window constructor
+	public static _ownerDocument: IDocument = null;
 	public readonly error: Error = null;
 	public readonly result: Buffer | ArrayBuffer | string = null;
 	public readonly readyState: number = FileReaderReadyStateEnum.empty;
@@ -28,10 +29,19 @@ export default class FileReader extends EventTarget {
 	public readonly onloadstart: (event: ProgressEvent) => void = null;
 	public readonly onloadend: (event: ProgressEvent) => void = null;
 	public readonly onprogress: (event: ProgressEvent) => void = null;
+	public readonly _ownerDocument: IDocument = null;
 	private _isTerminated = false;
 	private _loadTimeout: NodeJS.Timeout = null;
 	private _parseTimeout: NodeJS.Timeout = null;
 
+	/**
+	 * Constructor.
+	 */
+	constructor() {
+		super();
+		this._ownerDocument = (<typeof FileReader>this.constructor)._ownerDocument;
+	}
+
 	/**
 	 * Reads as ArrayBuffer.
 	 *
@@ -77,7 +87,7 @@ export default class FileReader extends EventTarget {
 	 * Aborts the file reader.
 	 */
 	public abort(): void {
-		const window = (<typeof FileReader>this.constructor)._ownerDocument.defaultView;
+		const window = this._ownerDocument.defaultView;
 
 		window.clearTimeout(this._loadTimeout);
 		window.clearTimeout(this._parseTimeout);
@@ -108,7 +118,7 @@ export default class FileReader extends EventTarget {
 	 * @param [encoding] Encoding.
 	 */
 	private _readFile(blob: Blob, format: FileReaderFormatEnum, encoding: string = null): void {
-		const window = (<typeof FileReader>this.constructor)._ownerDocument.defaultView;
+		const window = this._ownerDocument.defaultView;
 
 		if (this.readyState === FileReaderReadyStateEnum.loading) {
 			throw new DOMException(

package/src/index.ts

@@ -104,6 +104,7 @@ import Storage from './storage/Storage';
 import DOMRect from './nodes/element/DOMRect';
 import { URLSearchParams } from 'url';
 import Selection from './selection/Selection';
+import Range from './range/Range';
 import HTMLDialogElement from './nodes/html-dialog-element/HTMLDialogElement';
 import IHTMLDialogElement from './nodes/html-dialog-element/IHTMLDialogElement';
 
@@ -214,6 +215,7 @@ export {
 	DOMRect,
 	URLSearchParams,
 	Selection,
+	Range,
 	HTMLDialogElement,
 	IHTMLDialogElement
 };

package/src/nodes/document/Document.ts

@@ -38,12 +38,14 @@ import DocumentReadyStateManager from './DocumentReadyStateManager';
 import Location from '../../location/Location';
 import Selection from '../../selection/Selection';
 import IShadowRoot from '../shadow-root/IShadowRoot';
+import Range from '../../range/Range';
 import IHTMLBaseElement from '../html-base-element/IHTMLBaseElement';
 
 /**
  * Document.
  */
 export default class Document extends Node implements IDocument {
+	public static _defaultView: IWindow = null;
 	public onreadystatechange: (event: Event) => void = null;
 	public nodeType = Node.DOCUMENT_NODE;
 	public adoptedStyleSheets: CSSStyleSheet[] = [];
@@ -51,21 +53,26 @@ export default class Document extends Node implements IDocument {
 	public readonly children: IHTMLCollection<IElement> = HTMLCollectionFactory.create();
 	public readonly readyState = DocumentReadyStateEnum.interactive;
 	public readonly isConnected: boolean = true;
-	public _readyStateManager: DocumentReadyStateManager = null;
+	public readonly defaultView: IWindow;
+	public readonly _readyStateManager: DocumentReadyStateManager;
 	public _activeElement: IHTMLElement = null;
 	protected _isFirstWrite = true;
 	protected _isFirstWriteAfterOpen = false;
-	private _defaultView: IWindow = null;
 	private _cookie = '';
+	private _selection: Selection = null;
 
 	/**
 	 * Creates an instance of Document.
+	 *
+	 * @param defaultView Default view.
 	 */
 	constructor() {
 		super();
 
-		this.implementation = new DOMImplementation();
-		this.implementation._ownerDocument = this;
+		this.defaultView = (<typeof Document>this.constructor)._defaultView;
+		this.implementation = new DOMImplementation(this);
+
+		this._readyStateManager = new DocumentReadyStateManager(this.defaultView);
 
 		const doctype = this.implementation.createDocumentType('html', '', '');
 		const documentElement = this.createElement('html');
@@ -99,29 +106,6 @@ export default class Document extends Node implements IDocument {
 		return charset ? charset : 'UTF-8';
 	}
 
-	/**
-	 * Returns default view.
-	 *
-	 * @returns Default view.
-	 */
-	public get defaultView(): IWindow {
-		return this._defaultView;
-	}
-
-	/**
-	 * Sets a default view.
-	 *
-	 * @param defaultView Default view.
-	 */
-	public set defaultView(defaultView: IWindow) {
-		this._defaultView = defaultView;
-		this._readyStateManager = new DocumentReadyStateManager(defaultView);
-		this._readyStateManager.whenComplete().then(() => {
-			(<DocumentReadyStateEnum>this.readyState) = DocumentReadyStateEnum.complete;
-			this.dispatchEvent(new Event('readystatechange'));
-		});
-	}
-
 	/**
 	 * Last element child.
 	 *
@@ -271,7 +255,7 @@ export default class Document extends Node implements IDocument {
 	 * @returns Location.
 	 */
 	public get location(): Location {
-		return this._defaultView.location;
+		return this.defaultView.location;
 	}
 
 	/**
@@ -418,6 +402,8 @@ export default class Document extends Node implements IDocument {
 	 * @returns Cloned node.
 	 */
 	public cloneNode(deep = false): IDocument {
+		(<typeof Document>this.constructor)._defaultView = this.defaultView;
+
 		const clone = <Document>super.cloneNode(deep);
 
 		if (deep) {
@@ -428,8 +414,6 @@ export default class Document extends Node implements IDocument {
 			}
 		}
 
-		clone.defaultView = this.defaultView;
-
 		return clone;
 	}
 
@@ -654,14 +638,15 @@ export default class Document extends Node implements IDocument {
 			customElementClass = this.defaultView.customElements.get(tagName);
 		}
 
-		const elementClass = customElementClass || ElementTag[tagName] || HTMLUnknownElement;
+		const elementClass: typeof Element =
+			customElementClass || ElementTag[tagName] || HTMLUnknownElement;
 
-		elementClass.ownerDocument = this;
+		elementClass._ownerDocument = this;
 
 		const element = new elementClass();
 		element.tagName = tagName;
-		element.ownerDocument = this;
-		element.namespaceURI = namespaceURI;
+		(<IDocument>element.ownerDocument) = this;
+		(<string>element.namespaceURI) = namespaceURI;
 		if (element instanceof Element && options && options.is) {
 			element._isValue = String(options.is);
 		}
@@ -678,7 +663,7 @@ export default class Document extends Node implements IDocument {
 	 * @returns Text node.
 	 */
 	public createTextNode(data?: string): IText {
-		Text.ownerDocument = this;
+		Text._ownerDocument = this;
 		return new Text(data);
 	}
 
@@ -689,7 +674,7 @@ export default class Document extends Node implements IDocument {
 	 * @returns Text node.
 	 */
 	public createComment(data?: string): IComment {
-		Comment.ownerDocument = this;
+		Comment._ownerDocument = this;
 		return new Comment(data);
 	}
 
@@ -699,7 +684,7 @@ export default class Document extends Node implements IDocument {
 	 * @returns Document fragment.
 	 */
 	public createDocumentFragment(): IDocumentFragment {
-		DocumentFragment.ownerDocument = this;
+		DocumentFragment._ownerDocument = this;
 		return new DocumentFragment();
 	}
 
@@ -722,7 +707,7 @@ export default class Document extends Node implements IDocument {
 	 * @returns Event.
 	 */
 	public createEvent(type: string): Event {
-		if (this.defaultView[type]) {
+		if (typeof this.defaultView[type] === 'function') {
 			return new this.defaultView[type]('init');
 		}
 		return new Event('init');
@@ -772,6 +757,15 @@ export default class Document extends Node implements IDocument {
 		return clone;
 	}
 
+	/**
+	 * Creates a range.
+	 *
+	 * @returns Range.
+	 */
+	public createRange(): Range {
+		return new this.defaultView.Range();
+	}
+
 	/**
 	 * Adopts a node.
 	 *
@@ -794,7 +788,10 @@ export default class Document extends Node implements IDocument {
 	 * @returns Selection.
 	 */
 	public getSelection(): Selection {
-		return new Selection();
+		if (!this._selection) {
+			this._selection = new Selection(this);
+		}
+		return this._selection;
 	}
 
 	/**
@@ -818,4 +815,15 @@ export default class Document extends Node implements IDocument {
 
 		return returnValue;
 	}
+
+	/**
+	 * Triggered by window when it is ready.
+	 */
+	public _onWindowReady(): void {
+		this._readyStateManager.whenComplete().then(() => {
+			(<DocumentReadyStateEnum>this.readyState) = DocumentReadyStateEnum.complete;
+			this.dispatchEvent(new Event('readystatechange'));
+			this.dispatchEvent(new Event('load', { bubbles: true }));
+		});
+	}
 }

package/src/nodes/document/IDocument.ts

@@ -18,6 +18,7 @@ import CSSStyleSheet from '../../css/CSSStyleSheet';
 import Location from '../../location/Location';
 import DocumentReadyStateEnum from './DocumentReadyStateEnum';
 import INodeList from '../node/INodeList';
+import Range from '../../range/Range';
 
 /**
  * Document.
@@ -143,6 +144,13 @@ export default interface IDocument extends IParentNode {
 	 */
 	importNode(node: INode): INode;
 
+	/**
+	 * Creates a range.
+	 *
+	 * @returns Range.
+	 */
+	createRange(): Range;
+
 	/**
 	 * Returns an element by ID.
 	 *

package/src/nodes/element/DOMRectListFactory.ts

@@ -0,0 +1,33 @@
+import DOMRect from './DOMRect';
+import IDOMRectList from './IDOMRectList';
+
+/**
+ * DOM rect list factory.
+ *
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/getClientRects
+ */
+export default class DOMRectListFactory {
+	/**
+	 * Creates an HTMLCollection.
+	 *
+	 * @param list Nodes.
+	 * @returns HTMLCollection.
+	 */
+	public static create(list?: DOMRect[]): IDOMRectList<DOMRect> {
+		list = list ? list.slice() : [];
+		Object.defineProperty(list, 'item', {
+			value: this.getItem.bind(null, list)
+		});
+		return <IDOMRectList<DOMRect>>list;
+	}
+
+	/**
+	 * Returns node by index.
+	 *
+	 * @param list
+	 * @param index Index.
+	 */
+	private static getItem(list: DOMRect[], index: number): DOMRect {
+		return list[index] || null;
+	}
+}

package/src/nodes/element/Element.ts

@@ -2,7 +2,6 @@ import Node from '../node/Node';
 import ShadowRoot from '../shadow-root/ShadowRoot';
 import Attr from '../../attribute/Attr';
 import DOMRect from './DOMRect';
-import Range from './Range';
 import DOMTokenList from '../../dom-token-list/DOMTokenList';
 import IDOMTokenList from '../../dom-token-list/IDOMTokenList';
 import QuerySelector from '../../query-selector/QuerySelector';
@@ -25,6 +24,8 @@ import INodeList from '../node/INodeList';
 import HTMLCollectionFactory from './HTMLCollectionFactory';
 import { TInsertAdjacentPositions } from './IElement';
 import IText from '../text/IText';
+import IDOMRectList from './IDOMRectList';
+import DOMRectListFactory from './DOMRectListFactory';
 
 /**
  * Element.
@@ -169,12 +170,7 @@ export default class Element extends Node implements IElement {
 	 * @returns HTML.
 	 */
 	public get innerHTML(): string {
-		const xmlSerializer = new XMLSerializer();
-		let xml = '';
-		for (const node of this.childNodes) {
-			xml += xmlSerializer.serializeToString(node);
-		}
-		return xml;
+		return this.getInnerHTML();
 	}
 
 	/**
@@ -685,16 +681,19 @@ export default class Element extends Node implements IElement {
 	 * @returns DOM rect.
 	 */
 	public getBoundingClientRect(): DOMRect {
+		// TODO: Not full implementation
 		return new DOMRect();
 	}
 
 	/**
-	 * Returns a range.
+	 * Returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.
 	 *
-	 * @returns Range.
+	 * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/getClientRects
+	 * @returns DOM rect list.
 	 */
-	public createTextRange(): Range {
-		return new Range();
+	public getClientRects(): IDOMRectList<DOMRect> {
+		// TODO: Not full implementation
+		return DOMRectListFactory.create([this.getBoundingClientRect()]);
 	}
 
 	/**

package/src/nodes/element/IDOMRectList.ts

@@ -0,0 +1,11 @@
+/**
+ * HTMLCollection.
+ */
+export default interface IDOMRectList<T> extends Array<T> {
+	/**
+	 * Returns item by index.
+	 *
+	 * @param index Index.
+	 */
+	item(index: number): T;
+}

package/src/nodes/element/IElement.ts

@@ -1,12 +1,12 @@
 import IShadowRoot from '../shadow-root/IShadowRoot';
 import Attr from '../../attribute/Attr';
 import DOMRect from './DOMRect';
-import Range from './Range';
 import IDOMTokenList from '../../dom-token-list/IDOMTokenList';
 import INode from './../node/INode';
 import IChildNode from '../child-node/IChildNode';
 import IParentNode from '../parent-node/IParentNode';
 import INonDocumentTypeChildNode from '../child-node/INonDocumentTypeChildNode';
+import IDOMRectList from './IDOMRectList';
 
 export type TInsertAdjacentPositions = 'beforebegin' | 'afterbegin' | 'beforeend' | 'afterend';
 
@@ -161,11 +161,12 @@ export default interface IElement extends IChildNode, INonDocumentTypeChildNode,
 	getBoundingClientRect(): DOMRect;
 
 	/**
-	 * Returns a range.
+	 * Returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.
 	 *
-	 * @returns Range.
+	 * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/getClientRects
+	 * @returns DOM rect list.
 	 */
-	createTextRange(): Range;
+	getClientRects(): IDOMRectList<DOMRect>;
 
 	/**
 	 * The matches() method checks to see if the Element would be selected by the provided selectorString.

package/src/nodes/html-dialog-element/HTMLDialogElement.ts

@@ -9,12 +9,7 @@ import IHTMLDialogElement from './IHTMLDialogElement';
  * https://developer.mozilla.org/en-US/docs/Web/API/HTMLDialogElement.
  */
 export default class HTMLDialogElement extends HTMLElement implements IHTMLDialogElement {
-	/**
-	 * Returns returnValue.
-	 *
-	 * @returns ReturnValue.
-	 */
-	public returnValue: string;
+	public returnValue = '';
 
 	/**
 	 * Returns open.
@@ -28,12 +23,12 @@ export default class HTMLDialogElement extends HTMLElement implements IHTMLDialo
 	/**
 	 * Closes the dialog.
 	 *
-	 * @param returnValue ReturnValue.
+	 * @param [returnValue] ReturnValue.
 	 */
-	public close(returnValue?: string): void {
+	public close(returnValue = ''): void {
 		this.removeAttributeNS(null, 'open');
 		this.returnValue = returnValue;
-		this.dispatchEvent(new Event('close', { bubbles: false, cancelable: false }));
+		this.dispatchEvent(new Event('close'));
 	}
 
 	/**

package/src/nodes/html-dialog-element/IHTMLDialogElement.ts

@@ -9,7 +9,21 @@ import IHTMLElement from '../html-element/IHTMLElement';
 export default interface IHTMLDialogElement extends IHTMLElement {
 	open: boolean;
 	returnValue: string;
+
+	/**
+	 * Closes the dialog.
+	 *
+	 * @param [returnValue] ReturnValue.
+	 */
 	close(returnValue?: string): void;
+
+	/**
+	 * Shows the modal.
+	 */
 	showModal(): void;
+
+	/**
+	 * Shows the dialog.
+	 */
 	show(): void;
 }