pseudo-dom 0.5.1 → 0.7.0

package/dist/interfaces/PseudoElement.d.ts

@@ -470,9 +470,10 @@ export interface PseudoElement extends PseudoNode {
      */
     set ariaValueText(value: string);
     /**
-     * Inserts a set of Node objects or strings in the children list of the Element's parent, just after the Element.
+     * Inserts a set of Node objects or strings in the children list of the Element's parent, just after the Element. Does
+     * nothing when the element has no parent.
      */
-    after(...nodes: PseudoNode[]): void;
+    after(...nodes: Array<PseudoNode | string>): void;
     /**
      * A shortcut method to create and run an animation on an element. Returns the created Animation object instance.
      */
@@ -485,7 +486,7 @@ export interface PseudoElement extends PseudoNode {
     /**
      * Inserts a set of Node objects or strings after the last child of the element.
      */
-    append(...params: PseudoNode[]): void;
+    append(...nodes: Array<PseudoNode | string>): void;
     /**
      * Attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.
      */
@@ -496,17 +497,20 @@ export interface PseudoElement extends PseudoNode {
         slotAssignment: string;
     }): PseudoShadowRoot;
     /**
-     * Inserts a set of Node objects or strings in the children list of the Element's parent, just before the Element.
+     * Inserts a set of Node objects or strings in the children list of the Element's parent, just before the Element. Does
+     * nothing when the element has no parent.
      */
-    before(...params: PseudoNode[]): void;
+    before(...nodes: Array<PseudoNode | string>): void;
     /**
      * Returns whether an element is  expected to be visible or not based on configurable checks.
      */
     checkVisibility(): string;
     /**
      * Returns the Element which is the closest ancestor of the current element (or the current element itself) which matches the selectors given in parameter.
+     * @param {string} selectors A CSS selector
+     * @returns {PseudoElement|null}
      */
-    closest(): string;
+    closest(selectors: string): PseudoElement | null;
     /**
      * Returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.
      */
@@ -545,14 +549,19 @@ export interface PseudoElement extends PseudoNode {
     getClientRects(): string;
     /**
      * Returns a live HTMLCollection that contains all descendants of the current element that possess the list of classes given in the parameter.
+     * @param {string} className One or more space separated classes
+     * @returns {PseudoHTMLCollection}
      */
-    getElementsByClassName(): string;
+    getElementsByClassName(className: string): PseudoHTMLCollection;
     /**
      * Returns a live HTMLCollection containing all descendant elements, of a particular tag name, from the current element.
+     * @param {string} tagName A tag name, or * for every element
+     * @returns {PseudoHTMLCollection}
      */
-    getElementsByTagName(): string;
+    getElementsByTagName(tagName: string): PseudoHTMLCollection;
     /**
-     * Returns a live HTMLCollection containing all descendant elements, of a particular tag name and namespace, from the current element.
+     * Returns a live HTMLCollection containing all descendant elements, of a particular tag name and namespace, from
+     * the current element. Not implemented yet (namespaces are out of scope for now).
      */
     getElementsByTagNameNS(): string;
     /**
@@ -572,41 +581,55 @@ export interface PseudoElement extends PseudoNode {
      */
     hasPointerCapture(): string;
     /**
-     * Inserts a given element node at a given position relative to the element it is invoked upon.
+     * Inserts a given element at a given position relative to the element it is invoked upon.
+     * @param {string} position beforebegin, afterbegin, beforeend or afterend
+     * @param {PseudoElement} element The element to insert
+     * @returns {PseudoElement|null} The inserted element, or null when the position needs a parent this element does not have
      */
-    insertAdjacentElement(): string;
+    insertAdjacentElement(position: string, element: PseudoElement): PseudoElement | null;
     /**
-     * Parses the text as HTML or XML and inserts the resulting nodes into the tree in the position given.
+     * Parses the text as HTML or XML and inserts the resulting nodes into the tree in the position given. Not implemented
+     * yet (HTML parsing is out of scope for now).
+     * @param {string} position beforebegin, afterbegin, beforeend or afterend
+     * @param {string} text The markup to parse
      */
-    insertAdjacentHTML(): string;
+    insertAdjacentHTML(position: string, text: string): void;
     /**
-     * Inserts a given text node at a given position relative to the element it is invoked upon.
+     * Inserts a given text at a given position relative to the element it is invoked upon.
+     * @param {string} position beforebegin, afterbegin, beforeend or afterend
+     * @param {string} text The text to insert
      */
-    insertAdjacentText(): string;
+    insertAdjacentText(position: string, text: string): void;
     /**
      * Returns a boolean value indicating whether or not the element would be selected by the specified selector string.
+     * @param {string} selectors A CSS selector
+     * @returns {boolean}
      */
-    matches(): string;
+    matches(selectors: string): boolean;
     /**
      * Inserts a set of Node objects or strings before the first child of the element.
      */
-    prepend(): string;
+    prepend(...nodes: Array<PseudoNode | string>): void;
     /**
      * Returns the first Node which matches the specified selector string relative to the element.
+     * @param {string} selectors A CSS selector
+     * @returns {PseudoElement|null}
      */
-    querySelector(): string;
+    querySelector(selectors: string): PseudoElement | null;
     /**
      * Returns a NodeList of nodes which match the specified selector string relative to the element.
+     * @param {string} selectors A CSS selector
+     * @returns {Array<PseudoElement>}
      */
-    querySelectorAll(): string;
+    querySelectorAll(selectors: string): Array<PseudoElement>;
     /**
      * Releases (stops) pointer capture that was previously set for a specific pointer event.
      */
     releasePointerCapture(): string;
     /**
-     * Removes the element from the children list of its parent.
+     * Removes the element from the children list of its parent. Does nothing when it has no parent.
      */
-    remove(): string;
+    remove(): void;
     /**
      * Removes the named attribute from the current node.
      */
@@ -622,11 +645,12 @@ export interface PseudoElement extends PseudoNode {
     /**
      * Replaces the existing children of a Node with a specified new set of children.
      */
-    replaceChildren(): string;
+    replaceChildren(...nodes: Array<PseudoNode | string>): void;
     /**
-     * Replaces the element in the children list of its parent with a set of Node objects or strings.
+     * Replaces the element in the children list of its parent with a set of Node objects or strings. Does nothing when it
+     * has no parent.
      */
-    replaceWith(): string;
+    replaceWith(...nodes: Array<PseudoNode | string>): void;
     /**
      * Asynchronously asks the browser to make the element fullscreen.
      */

package/dist/interfaces/PseudoElement.js

@@ -1,5 +1,5 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})

package/dist/interfaces/PseudoEvent.d.ts

@@ -1,79 +1,79 @@
-/**
- * @file Substitute for the DOM Event Class.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.0.0
- */
-import { PseudoEventTarget } from './PseudoEventTarget';
-/**
- * Simulate the behaviour of the Event Class when there is no DOM available.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @class
- * @property {number} NONE
- * @property {number} CAPTURING_PHASE
- * @property {number} AT_TARGET
- * @property {number} BUBBLING_PHASE
- * @property {boolean} bubbles - A Boolean indicating whether the event bubbles up through the Dom or not.
- * @property {boolean} cancelable - A Boolean indicating whether the event is cancelable.
- * @property {boolean} composed - A Boolean value indicating whether the event can bubble across the boundary
- * between the shadow Dom and the regular Dom.
- * @property {function|PseudoEventTarget} currentTarget - A reference to the currently registered target for the event. This
- * is the object to which the event is currently slated to be sent; it's possible this has been changed along the way
- * through re-targeting.
- * @property {boolean} defaultPrevented - Indicates whether event.preventDefault() has been called on the event.
- * @property {int} eventPhase - Indicates which phase of the event flow is being processed. Uses PseudoEvent constants.
- * @property {EventTarget|PseudoEventTarget} target - A reference to the target to which the event was originally
- * dispatched.
- * @property {int} timeStamp - The time at which the event was created (in milliseconds). By specification, this
- * value is time since epoch, but in reality browsers' definitions vary; in addition, work is underway to change this
- * to be a DomHighResTimeStamp instead.
- * @property {string} type - The name of the event (case-insensitive).
- * @property {boolean} isTrusted - Indicates whether the event was initiated by the browser (after a user
- * click for instance) or by a script (using an event creation method, like event.initEvent)
- */
-export interface PseudoEvent {
-    /**
-     *
-     * @param {string} type
-     * @param {Object} [eventOptions={}]
-     * @param {boolean} [eventOptions.bubbles=true]
-     * @param {boolean} [eventOptions.cancelable=true]
-     * @param {boolean} [eventOptions.composed=true]
-     * @constructor
-     */
-    get bubbles(): boolean;
-    get cancelable(): boolean;
-    get composed(): boolean;
-    get currentTarget(): PseudoEventTarget;
-    get defaultPrevented(): boolean;
-    get eventPhase(): number;
-    get isTrusted(): boolean;
-    get target(): PseudoEventTarget;
-    get timeStamp(): number;
-    get type(): string;
-    /**
-     * Return an array of targets that will have the event executed open them. The order is based on the eventPhase
-     * @method
-     * @returns {Array.<PseudoEventTarget>}
-     */
-    composedPath(): Array<PseudoEventTarget>;
-    /**
-     * Cancels the event (if it is cancelable).
-     * @method
-     * @returns {null}
-     */
-    preventDefault(): null;
-    /**
-     * For this particular event, no other listener will be called.
-     * Neither those attached on the same element, nor those attached on elements which will be traversed later (in
-     * capture phase, for instance)
-     * @method
-     * @returns {null}
-     */
-    stopImmediatePropagation(): null;
-    /**
-     * Stops the propagation of events further along in the Dom.
-     * @method
-     * @returns {null}
-     */
-    stopPropagation(): null;
-}
+/**
+ * @file Substitute for the DOM Event Class.
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @version 1.0.0
+ */
+import { PseudoEventTarget } from './PseudoEventTarget';
+/**
+ * Simulate the behaviour of the Event Class when there is no DOM available.
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @class
+ * @property {number} NONE
+ * @property {number} CAPTURING_PHASE
+ * @property {number} AT_TARGET
+ * @property {number} BUBBLING_PHASE
+ * @property {boolean} bubbles - A Boolean indicating whether the event bubbles up through the Dom or not.
+ * @property {boolean} cancelable - A Boolean indicating whether the event is cancelable.
+ * @property {boolean} composed - A Boolean value indicating whether the event can bubble across the boundary
+ * between the shadow Dom and the regular Dom.
+ * @property {function|PseudoEventTarget} currentTarget - A reference to the currently registered target for the event. This
+ * is the object to which the event is currently slated to be sent; it's possible this has been changed along the way
+ * through re-targeting.
+ * @property {boolean} defaultPrevented - Indicates whether event.preventDefault() has been called on the event.
+ * @property {int} eventPhase - Indicates which phase of the event flow is being processed. Uses PseudoEvent constants.
+ * @property {EventTarget|PseudoEventTarget} target - A reference to the target to which the event was originally
+ * dispatched.
+ * @property {int} timeStamp - The time at which the event was created (in milliseconds). By specification, this
+ * value is time since epoch, but in reality browsers' definitions vary; in addition, work is underway to change this
+ * to be a DomHighResTimeStamp instead.
+ * @property {string} type - The name of the event (case-insensitive).
+ * @property {boolean} isTrusted - Indicates whether the event was initiated by the browser (after a user
+ * click for instance) or by a script (using an event creation method, like event.initEvent)
+ */
+export interface PseudoEvent {
+    /**
+     *
+     * @param {string} type
+     * @param {Object} [eventOptions={}]
+     * @param {boolean} [eventOptions.bubbles=true]
+     * @param {boolean} [eventOptions.cancelable=true]
+     * @param {boolean} [eventOptions.composed=true]
+     * @constructor
+     */
+    get bubbles(): boolean;
+    get cancelable(): boolean;
+    get composed(): boolean;
+    get currentTarget(): PseudoEventTarget;
+    get defaultPrevented(): boolean;
+    get eventPhase(): number;
+    get isTrusted(): boolean;
+    get target(): PseudoEventTarget;
+    get timeStamp(): number;
+    get type(): string;
+    /**
+     * Return an array of targets that will have the event executed open them. The order is based on the eventPhase
+     * @method
+     * @returns {Array.<PseudoEventTarget>}
+     */
+    composedPath(): Array<PseudoEventTarget>;
+    /**
+     * Cancels the event (if it is cancelable).
+     * @method
+     * @returns {null}
+     */
+    preventDefault(): null;
+    /**
+     * For this particular event, no other listener will be called.
+     * Neither those attached on the same element, nor those attached on elements which will be traversed later (in
+     * capture phase, for instance)
+     * @method
+     * @returns {null}
+     */
+    stopImmediatePropagation(): null;
+    /**
+     * Stops the propagation of events further along in the Dom.
+     * @method
+     * @returns {null}
+     */
+    stopPropagation(): null;
+}

package/dist/interfaces/PseudoEvent.js

@@ -1,10 +1,10 @@
-'use strict'
-
-/**
- * @file Substitute for the DOM Event Class.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.0.0
- */
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
+'use strict'
+
+/**
+ * @file Substitute for the DOM Event Class.
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @version 1.0.0
+ */
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})

package/dist/interfaces/PseudoEventTarget.d.ts

@@ -1,46 +1,46 @@
-/**
- * @file Substitute for the DOM EventTarget Class.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.0.0
- */
-import { PseudoEvent } from './PseudoEvent';
-export type listenerOptions = {
-    capture: boolean;
-    once: boolean;
-    passive: boolean;
-};
-/**
- * Simulate the behaviour of the EventTarget Class when there is no DOM available.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @interface
- * @property {function} addEventListener
- * @property {function} removeEventListener
- * @property {function} dispatchEvent
- */
-export interface PseudoEventTarget {
-    /**
-     * Creates a new EventTarget object instance.
-     */
-    /**
-     * Registers an event handler of a specific event type on the EventTarget.
-     * @param {string} type
-     * @param {function|Object} callback
-     * @param {boolean|Object} [useCapture=false]
-     */
-    addEventListener(type: string, callback: Function | {
-        handleEvent: Function;
-    } | any, useCapture: listenerOptions | boolean): void;
-    /**
-     * Removes an event listener from the EventTarget.
-     * @param {string} type
-     * @param {function} callback
-     */
-    removeEventListener(type: string, callback: Function, options?: listenerOptions | boolean): void;
-    /**
-     * Dispatches an event to this EventTarget.
-     * @param {Event|PseudoEvent} event
-     * @param {EventTarget|PseudoEventTarget} target
-     * @returns {boolean}
-     */
-    dispatchEvent(event: PseudoEvent): boolean;
-}
+/**
+ * @file Substitute for the DOM EventTarget Class.
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @version 1.0.0
+ */
+import { PseudoEvent } from './PseudoEvent';
+export type listenerOptions = {
+    capture: boolean;
+    once: boolean;
+    passive: boolean;
+};
+/**
+ * Simulate the behaviour of the EventTarget Class when there is no DOM available.
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @interface
+ * @property {function} addEventListener
+ * @property {function} removeEventListener
+ * @property {function} dispatchEvent
+ */
+export interface PseudoEventTarget {
+    /**
+     * Creates a new EventTarget object instance.
+     */
+    /**
+     * Registers an event handler of a specific event type on the EventTarget.
+     * @param {string} type
+     * @param {function|Object} callback
+     * @param {boolean|Object} [useCapture=false]
+     */
+    addEventListener(type: string, callback: Function | {
+        handleEvent: Function;
+    } | any, useCapture: listenerOptions | boolean): void;
+    /**
+     * Removes an event listener from the EventTarget.
+     * @param {string} type
+     * @param {function} callback
+     */
+    removeEventListener(type: string, callback: Function, options?: listenerOptions | boolean): void;
+    /**
+     * Dispatches an event to this EventTarget.
+     * @param {Event|PseudoEvent} event
+     * @param {EventTarget|PseudoEventTarget} target
+     * @returns {boolean}
+     */
+    dispatchEvent(event: PseudoEvent): boolean;
+}

package/dist/interfaces/PseudoEventTarget.js

@@ -1,5 +1,5 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})

package/dist/interfaces/PseudoHTMLCollection.d.ts

@@ -1,2 +1,23 @@
-export interface PseudoHTMLCollection {
-}
+import { PseudoElement } from './PseudoElement';
+/**
+ * A live collection of an element's (or a document's / document fragment's) element children: it is not a snapshot,
+ * reading it after the tree changes reflects the change.
+ */
+export interface PseudoHTMLCollection extends Iterable<PseudoElement> {
+    /**
+     * How many elements are in the collection.
+     */
+    get length(): number;
+    /**
+     * The element at the given index, or null when there is none.
+     * @param {number} index
+     * @returns {PseudoElement|null}
+     */
+    item(index: number): PseudoElement | null;
+    /**
+     * The element whose id, or whose name attribute, is the given value, or null when there is none.
+     * @param {string} name
+     * @returns {PseudoElement|null}
+     */
+    namedItem(name: string): PseudoElement | null;
+}

package/dist/interfaces/PseudoHTMLCollection.js

@@ -1,5 +1,5 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})

package/dist/interfaces/PseudoHTMLElement.d.ts

@@ -1,22 +1,22 @@
-/**
- * @file Substitute for the DOM HTMLElement Class.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.0.0
- */
-import { PseudoElement } from './PseudoElement';
-/**
- * Simulate the behaviour of the HTMLElement Class when there is no DOM available.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @class
- * @augments PseudoElement
- * @property {boolean} hidden - State of whether element is visible
- * @property {number} offsetHeight - The height of the element as offset by the parent element
- * @property {number} offsetLeft - The position of the left side of the element based on the parent element
- * @property {PseudoHTMLElement} offsetParent - A reference to the closest positioned parent element
- * @property {number} offsetTop - The position of the top side of the element based on the parent element
- * @property {number} offsetWidth - The width of the element as offset by the parent element
- * @property {Object} style - A container to define all applied inline-styles
- * @property {string} title - The title attribute which affects the text visible on hover
- */
-export interface PseudoHTMLElement extends PseudoElement {
-}
+/**
+ * @file Substitute for the DOM HTMLElement Class.
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @version 1.0.0
+ */
+import { PseudoElement } from './PseudoElement';
+/**
+ * Simulate the behaviour of the HTMLElement Class when there is no DOM available.
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @class
+ * @augments PseudoElement
+ * @property {boolean} hidden - State of whether element is visible
+ * @property {number} offsetHeight - The height of the element as offset by the parent element
+ * @property {number} offsetLeft - The position of the left side of the element based on the parent element
+ * @property {PseudoHTMLElement} offsetParent - A reference to the closest positioned parent element
+ * @property {number} offsetTop - The position of the top side of the element based on the parent element
+ * @property {number} offsetWidth - The width of the element as offset by the parent element
+ * @property {Object} style - A container to define all applied inline-styles
+ * @property {string} title - The title attribute which affects the text visible on hover
+ */
+export interface PseudoHTMLElement extends PseudoElement {
+}

package/dist/interfaces/PseudoHTMLElement.js

@@ -1,5 +1,5 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})

package/dist/interfaces/PseudoHTMLSlotElement.d.ts

@@ -1,3 +1,3 @@
-import { PseudoHTMLElement } from './PseudoHTMLElement';
-export interface PseudoHTMLSlotElement extends PseudoHTMLElement {
-}
+import { PseudoHTMLElement } from './PseudoHTMLElement';
+export interface PseudoHTMLSlotElement extends PseudoHTMLElement {
+}

package/dist/interfaces/PseudoHTMLSlotElement.js

@@ -1,5 +1,5 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})

package/dist/interfaces/PseudoNamedNodeMap.d.ts

@@ -1,11 +1,11 @@
-import { PseudoAttr } from './PseudoAttr';
-export interface PseudoNamedNodeMap {
-    get length(): number;
-    getNamedItem(name: string): PseudoAttr | null;
-    setNamedItem(attr: PseudoAttr): PseudoAttr | null;
-    removeNamedItem(attrName: string): PseudoAttr;
-    item(index: number): PseudoAttr | null;
-    getNamedItemNS(namespace: string, localName: string): PseudoAttr | null;
-    setNamedItemNS(attr: PseudoAttr): PseudoAttr | null;
-    removeNamedItemNS(namespace: string, localName: string): PseudoAttr;
-}
+import { PseudoAttr } from './PseudoAttr';
+export interface PseudoNamedNodeMap {
+    get length(): number;
+    getNamedItem(name: string): PseudoAttr | null;
+    setNamedItem(attr: PseudoAttr): PseudoAttr | null;
+    removeNamedItem(attrName: string): PseudoAttr;
+    item(index: number): PseudoAttr | null;
+    getNamedItemNS(namespace: string, localName: string): PseudoAttr | null;
+    setNamedItemNS(attr: PseudoAttr): PseudoAttr | null;
+    removeNamedItemNS(namespace: string, localName: string): PseudoAttr;
+}

package/dist/interfaces/PseudoNamedNodeMap.js

@@ -1,5 +1,5 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})