pseudo-dom 0.17.0 → 1.0.1

package/dist/interfaces/PseudoHTMLElement.d.ts

@@ -1,22 +1,17 @@
 /**
- * @file Substitute for the DOM HTMLElement Class.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.0.0
+ * Substitute for the DOM HTMLElement Class.
  */
 import { PseudoElement } from './PseudoElement';
 import { PseudoCSSStyleDeclaration } from './PseudoCSSStyleDeclaration';
 /**
  * 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 {string} title - The title attribute which affects the text visible on hover
+ *
+ * It also has these simple properties, which are stored as attributes:
+ * - `hidden`: state of whether the element is visible
+ * - `title`: the title attribute, which affects the text visible on hover
+ * - `offsetHeight`, `offsetWidth`: the height and width of the element as offset by the parent element
+ * - `offsetLeft`, `offsetTop`: the position of the left and top sides of the element based on the parent element
+ * - `offsetParent`: a reference to the closest positioned parent element
  */
 export interface PseudoHTMLElement extends PseudoElement {
     /**

package/dist/interfaces/PseudoNode.d.ts

@@ -1,7 +1,5 @@
 /**
- * @file Substitute for the DOM Node Class.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.0.0
+ * Substitute for the DOM Node Class.
  */
 import { PseudoEventTarget } from './PseudoEventTarget';
 import { PseudoNodeList } from '../classes/PseudoNodeList';
@@ -11,12 +9,6 @@ import { PseudoElement } from './PseudoElement';
 import { PseudoDocumentFragment } from './PseudoDocumentFragment';
 /**
  * Simulate the behaviour of the Node Class when there is no DOM available.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @class
- * @augments PseudoEventTarget
- * @property {string} name
- * @property {function} appendChild
- * @property {function} removeChild
  */
 export interface PseudoNode extends PseudoEventTarget {
     /**
@@ -99,8 +91,7 @@ export interface PseudoNode extends PseudoEventTarget {
     set textContent(text: string | null);
     /**
      * Adds the specified childNode argument as the last child to the current node. If the argument referenced an existing node on the DOM tree, the node will be detached from its current position and attached at the new position.
-     * @param {PseudoNode} childNode
-     * @returns {PseudoNode}
+     * @param childNode
      */
     appendChild(childNode: PseudoNode): PseudoNode;
     /**
@@ -166,8 +157,7 @@ export interface PseudoNode extends PseudoEventTarget {
     normalize(): void;
     /**
      * Removes a child node from the current element, which must be a child of the current node.
-     * @param {PseudoNode} child
-     * @returns {PseudoNode}
+     * @param child
      */
     removeChild(child: PseudoNode): PseudoNode;
     /**

package/dist/main.d.ts

@@ -1,7 +1,5 @@
 /**
- * @file All of the Pseudo Dom Helper Objects functions for simulating parts of the DOM when running scripts in NodeJs.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.0.0
+ * All of the Pseudo Dom Helper Objects functions for simulating parts of the DOM when running scripts in NodeJs.
  */
 import { EventService as PseudoEvent } from './services/EventService';
 import PseudoEventTarget from './services/EventTargetService';
@@ -26,9 +24,6 @@ import simulate from './simulate';
 import { TextService as PseudoText, CommentService as PseudoComment } from './services/NodeService';
 /**
  * All methods exported from this module are encapsulated within pseudoDom.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @typedef {Object} pseudoDom
- * @module pseudoDom/objects
  */
 declare const pseudoDom: {
     generateDocument: (root: Window | any, context?: object) => Window | PseudoEventTarget;

package/dist/main.js

@@ -1,9 +1,7 @@
 'use strict'
 
 /**
- * @file All of the Pseudo Dom Helper Objects functions for simulating parts of the DOM when running scripts in NodeJs.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.0.0
+ * All of the Pseudo Dom Helper Objects functions for simulating parts of the DOM when running scripts in NodeJs.
  */
 const __importDefault = void 0 && (void 0).__importDefault || function (mod) {
   return mod && mod.__esModule
@@ -131,9 +129,6 @@ Object.defineProperty(exports, 'PseudoComment', {
 })
 /**
  * All methods exported from this module are encapsulated within pseudoDom.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @typedef {Object} pseudoDom
- * @module pseudoDom/objects
  */
 const pseudoDom = {
   generateDocument: generateDocument_1.default,

package/dist/services/AttrService.d.ts

@@ -3,9 +3,6 @@ import { PseudoElement } from '../interfaces/PseudoElement';
 import { NodeService } from './NodeService';
 /**
  * Simulate the behaviour of the Attr Class when there is no DOM available.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @class
- * @augments NodeService
  */
 export declare class AttrService extends NodeService implements PseudoAttr {
     value: string;
@@ -14,12 +11,11 @@ export declare class AttrService extends NodeService implements PseudoAttr {
     private readonly namespace;
     private readonly namespacePrefix;
     /**
-     * @param {string} name The name of the attribute
-     * @param {string} [value=''] The value of the attribute
-     * @param {PseudoElement|null} [ownerElement=null] The element which has this attribute
-     * @param {string} [namespaceURI=''] The namespace of the attribute
-     * @param {string|null} [prefix=null] The namespace prefix of the attribute
-     * @constructor
+     * @param name The name of the attribute
+     * @param value The value of the attribute
+     * @param ownerElement The element which has this attribute
+     * @param namespaceURI The namespace of the attribute
+     * @param prefix The namespace prefix of the attribute
      */
     constructor(name?: string, value?: string, ownerElement?: PseudoElement | null, namespaceURI?: string, prefix?: string | null);
     protected get acceptsChildren(): boolean;

package/dist/services/AttrService.js

@@ -7,18 +7,14 @@ exports.AttrService = void 0
 const NodeService_1 = require('./NodeService')
 /**
  * Simulate the behaviour of the Attr Class when there is no DOM available.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @class
- * @augments NodeService
  */
 class AttrService extends NodeService_1.NodeService {
   /**
-   * @param {string} name The name of the attribute
-   * @param {string} [value=''] The value of the attribute
-   * @param {PseudoElement|null} [ownerElement=null] The element which has this attribute
-   * @param {string} [namespaceURI=''] The namespace of the attribute
-   * @param {string|null} [prefix=null] The namespace prefix of the attribute
-   * @constructor
+   * @param name The name of the attribute
+   * @param value The value of the attribute
+   * @param ownerElement The element which has this attribute
+   * @param namespaceURI The namespace of the attribute
+   * @param prefix The namespace prefix of the attribute
    */
   constructor (name = '', value = '', ownerElement = null, namespaceURI = '', prefix = null) {
     super()

package/dist/services/CSSStyleDeclarationService.d.ts

@@ -1,7 +1,5 @@
 /**
- * @file Substitute for the DOM CSSStyleDeclaration Class (the object behind Element.style).
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.0.0
+ * Substitute for the DOM CSSStyleDeclaration Class (the object behind Element.style).
  */
 /**
  * Simulate the behaviour of the CSSStyleDeclaration Class when there is no DOM available: an ordered map of CSS
@@ -9,64 +7,53 @@
  * given, with no unit conversion, shorthand expansion or validation - this is a data structure, not a real CSS
  * engine. Named property access (declaration.backgroundColor, camelCase) is added on top of this by
  * createStyleDeclaration, which wraps an instance of this class in a Proxy.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @class
  */
 export declare class CSSStyleDeclarationService {
     private readonly properties;
     /**
-     * @param {string} [cssText=''] Initial declarations, as CSS text ("color: red; font-size: 12px;")
-     * @constructor
+     * @param cssText Initial declarations, as CSS text ("color: red; font-size: 12px;")
      */
     constructor(cssText?: string);
     /**
      * How many properties are currently set.
-     * @returns {number}
      */
     get length(): number;
     /**
      * The name of the property at the given index, in the order it was set, or '' when there is none (matches the
      * DOM's CSSStyleDeclaration, which is array-like).
-     * @param {number} index
-     * @returns {string}
+     * @param index
      */
     item(index: number): string;
     /**
      * The value of the given property, or '' when it is not set.
-     * @param {string} property A CSS property name (kebab-case, e.g. "background-color")
-     * @returns {string}
+     * @param property A CSS property name (kebab-case, e.g. "background-color")
      */
     getPropertyValue(property: string): string;
     /**
      * "important" when the property was set with !important, otherwise ''.
-     * @param {string} property A CSS property name (kebab-case)
-     * @returns {string}
+     * @param property A CSS property name (kebab-case)
      */
     getPropertyPriority(property: string): string;
     /**
      * Set a property's value (and optionally its priority). An empty, null or undefined value removes the property
      * instead, like the DOM.
-     * @param {string} property A CSS property name (kebab-case)
-     * @param {string} value The value, or '' to remove the property
-     * @param {string} [priority=''] "important" to mark it !important
-     * @returns {undefined}
+     * @param property A CSS property name (kebab-case)
+     * @param value The value, or '' to remove the property
+     * @param priority "important" to mark it !important
      */
     setProperty(property: string, value: string, priority?: string): void;
     /**
      * Remove a property, returning the value it had (or '' when it was not set).
-     * @param {string} property A CSS property name (kebab-case)
-     * @returns {string}
+     * @param property A CSS property name (kebab-case)
      */
     removeProperty(property: string): string;
     /**
      * All the declarations as one CSS text string.
-     * @returns {string}
      */
     get cssText(): string;
     /**
      * Replace every declaration by parsing a CSS text string ("color: red; font-size: 12px !important;").
-     * @param {string} cssText
-     * @returns {undefined}
+     * @param cssText
      */
     set cssText(cssText: string);
 }

package/dist/services/CSSStyleDeclarationService.js

@@ -1,9 +1,7 @@
 'use strict'
 
 /**
- * @file Substitute for the DOM CSSStyleDeclaration Class (the object behind Element.style).
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.0.0
+ * Substitute for the DOM CSSStyleDeclaration Class (the object behind Element.style).
  */
 require('core-js/modules/esnext.iterator.constructor.js')
 require('core-js/modules/esnext.iterator.for-each.js')
@@ -31,13 +29,10 @@ exports.CSSStyleDeclarationService = void 0
  * given, with no unit conversion, shorthand expansion or validation - this is a data structure, not a real CSS
  * engine. Named property access (declaration.backgroundColor, camelCase) is added on top of this by
  * createStyleDeclaration, which wraps an instance of this class in a Proxy.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @class
  */
 class CSSStyleDeclarationService {
   /**
-   * @param {string} [cssText=''] Initial declarations, as CSS text ("color: red; font-size: 12px;")
-   * @constructor
+   * @param cssText Initial declarations, as CSS text ("color: red; font-size: 12px;")
    */
   constructor (cssText = '') {
     this.properties = new Map()
@@ -46,7 +41,6 @@ class CSSStyleDeclarationService {
 
   /**
    * How many properties are currently set.
-   * @returns {number}
    */
   get length () {
     return this.properties.size
@@ -55,8 +49,7 @@ class CSSStyleDeclarationService {
   /**
    * The name of the property at the given index, in the order it was set, or '' when there is none (matches the
    * DOM's CSSStyleDeclaration, which is array-like).
-   * @param {number} index
-   * @returns {string}
+   * @param index
    */
   item (index) {
     return Array.from(this.properties.keys())[index] || ''
@@ -64,8 +57,7 @@ class CSSStyleDeclarationService {
 
   /**
    * The value of the given property, or '' when it is not set.
-   * @param {string} property A CSS property name (kebab-case, e.g. "background-color")
-   * @returns {string}
+   * @param property A CSS property name (kebab-case, e.g. "background-color")
    */
   getPropertyValue (property) {
     const entry = this.properties.get(property)
@@ -74,8 +66,7 @@ class CSSStyleDeclarationService {
 
   /**
    * "important" when the property was set with !important, otherwise ''.
-   * @param {string} property A CSS property name (kebab-case)
-   * @returns {string}
+   * @param property A CSS property name (kebab-case)
    */
   getPropertyPriority (property) {
     const entry = this.properties.get(property)
@@ -85,10 +76,9 @@ class CSSStyleDeclarationService {
   /**
    * Set a property's value (and optionally its priority). An empty, null or undefined value removes the property
    * instead, like the DOM.
-   * @param {string} property A CSS property name (kebab-case)
-   * @param {string} value The value, or '' to remove the property
-   * @param {string} [priority=''] "important" to mark it !important
-   * @returns {undefined}
+   * @param property A CSS property name (kebab-case)
+   * @param value The value, or '' to remove the property
+   * @param priority "important" to mark it !important
    */
   setProperty (property, value, priority = '') {
     if (value === '' || value === null || typeof value === 'undefined') {
@@ -103,8 +93,7 @@ class CSSStyleDeclarationService {
 
   /**
    * Remove a property, returning the value it had (or '' when it was not set).
-   * @param {string} property A CSS property name (kebab-case)
-   * @returns {string}
+   * @param property A CSS property name (kebab-case)
    */
   removeProperty (property) {
     const value = this.getPropertyValue(property)
@@ -114,7 +103,6 @@ class CSSStyleDeclarationService {
 
   /**
    * All the declarations as one CSS text string.
-   * @returns {string}
    */
   get cssText () {
     return Array.from(this.properties.entries()).map(([property, {
@@ -125,8 +113,7 @@ class CSSStyleDeclarationService {
 
   /**
    * Replace every declaration by parsing a CSS text string ("color: red; font-size: 12px !important;").
-   * @param {string} cssText
-   * @returns {undefined}
+   * @param cssText
    */
   set cssText (cssText) {
     this.properties.clear()

package/dist/services/CustomEventService.d.ts

@@ -1,36 +1,25 @@
 /**
- * @file Substitute for the DOM CustomEvent Class.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.0.0
+ * Substitute for the DOM CustomEvent Class.
  */
 import { EventService } from './EventService';
 /**
  * The options for creating a custom event.
- * @typedef {Object} CustomEventInit
- * @property {boolean} [bubbles=false]
- * @property {boolean} [cancelable=false]
- * @property {boolean} [composed=false]
- * @property {*} [detail=null] Whatever data the event should carry
  */
 export type CustomEventInit = {
     bubbles?: boolean;
     cancelable?: boolean;
     composed?: boolean;
+    /** Whatever data the event should carry (default null) */
     detail?: any;
 };
 /**
  * Simulate the behaviour of the CustomEvent Class when there is no DOM available: an event which carries data.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @class
- * @augments EventService
- * @property {*} detail
  */
 export declare class CustomEventService extends EventService {
     private readonly eventDetail;
     /**
-     * @param {string} [typeArg=''] The type of the event
-     * @param {CustomEventInit} [init={}] The options for the event
-     * @constructor
+     * @param typeArg The type of the event
+     * @param init The options for the event
      */
     constructor(typeArg?: string, init?: CustomEventInit);
     get detail(): any;

package/dist/services/CustomEventService.js

@@ -5,23 +5,16 @@ Object.defineProperty(exports, '__esModule', {
 })
 exports.CustomEventService = void 0
 /**
- * @file Substitute for the DOM CustomEvent Class.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.0.0
+ * Substitute for the DOM CustomEvent Class.
  */
 const EventService_1 = require('./EventService')
 /**
  * Simulate the behaviour of the CustomEvent Class when there is no DOM available: an event which carries data.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @class
- * @augments EventService
- * @property {*} detail
  */
 class CustomEventService extends EventService_1.EventService {
   /**
-   * @param {string} [typeArg=''] The type of the event
-   * @param {CustomEventInit} [init={}] The options for the event
-   * @constructor
+   * @param typeArg The type of the event
+   * @param init The options for the event
    */
   constructor (typeArg = '', init = {}) {
     super(typeArg, init)

package/dist/services/DOMTokenListService.d.ts

@@ -1,16 +1,13 @@
 import { PseudoDOMTokenList } from '../interfaces/PseudoDOMTokenList';
 /**
  * Simulate the behaviour of the DOMTokenList Class when there is no DOM available.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @class
  */
 export declare class DOMTokenListService implements PseudoDOMTokenList {
     private tokens;
     private readonly onChange;
     /**
-     * @param {string} [value=''] The space separated tokens to start with
-     * @param {function(string): void} [onChange] Called with the new value whenever the tokens change
-     * @constructor
+     * @param value The space separated tokens to start with
+     * @param onChange Called with the new value whenever the tokens change
      */
     constructor(value?: string, onChange?: (value: string) => void);
     private static parse;

package/dist/services/DOMTokenListService.js

@@ -10,14 +10,11 @@ Object.defineProperty(exports, '__esModule', {
 exports.DOMTokenListService = void 0
 /**
  * Simulate the behaviour of the DOMTokenList Class when there is no DOM available.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @class
  */
 class DOMTokenListService {
   /**
-   * @param {string} [value=''] The space separated tokens to start with
-   * @param {function(string): void} [onChange] Called with the new value whenever the tokens change
-   * @constructor
+   * @param value The space separated tokens to start with
+   * @param onChange Called with the new value whenever the tokens change
    */
   constructor (value = '', onChange = () => undefined) {
     this.tokens = DOMTokenListService.parse(value)

package/dist/services/DocumentFragmentService.d.ts

@@ -4,9 +4,6 @@ import { PseudoElement } from '../interfaces/PseudoElement';
 /**
  * Simulate the behaviour of the DocumentFragment Class when there is no DOM available: a container for nodes which is
  * not part of a tree, when it is inserted its children are moved into the tree instead.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @class
- * @augments NodeService
  */
 export declare class DocumentFragmentService extends NodeService implements PseudoDocumentFragment {
     get nodeName(): string;
@@ -14,8 +11,7 @@ export declare class DocumentFragmentService extends NodeService implements Pseu
     /**
      * The first element, in tree order, whose id matches the given value, or null when there is none (the DOM's
      * NonElementParentNode mixin, which Document and DocumentFragment both implement).
-     * @param {string} id
-     * @returns {PseudoElement|null}
+     * @param id
      */
     getElementById(id: string): PseudoElement | null;
 }

package/dist/services/DocumentFragmentService.js

@@ -16,9 +16,6 @@ const getElementById_1 = __importDefault(require('../functions/getElementById'))
 /**
  * Simulate the behaviour of the DocumentFragment Class when there is no DOM available: a container for nodes which is
  * not part of a tree, when it is inserted its children are moved into the tree instead.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @class
- * @augments NodeService
  */
 class DocumentFragmentService extends NodeService_1.NodeService {
   get nodeName () {
@@ -32,8 +29,7 @@ class DocumentFragmentService extends NodeService_1.NodeService {
   /**
    * The first element, in tree order, whose id matches the given value, or null when there is none (the DOM's
    * NonElementParentNode mixin, which Document and DocumentFragment both implement).
-   * @param {string} id
-   * @returns {PseudoElement|null}
+   * @param id
    */
   getElementById (id) {
     return (0, getElementById_1.default)(this, id)

package/dist/services/DocumentService.d.ts

@@ -4,9 +4,6 @@ import { PseudoElement } from '../interfaces/PseudoElement';
 import { DocumentFragmentService } from './DocumentFragmentService';
 /**
  * Simulate the behaviour of the Document Class when there is no DOM available.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @class
- * @augments NodeService
  */
 export declare class DocumentService extends NodeService implements PseudoDocument {
     get nodeName(): string;
@@ -15,32 +12,27 @@ export declare class DocumentService extends NodeService implements PseudoDocume
     set textContent(text: string | null);
     /**
      * The first element, in tree order, whose id matches the given value, or null when there is none.
-     * @param {string} id
-     * @returns {PseudoElement|null}
+     * @param id
      */
     getElementById(id: string): PseudoElement | null;
     /**
      * Make an element of the given type which belongs to this document but is not added anywhere until it is appended.
-     * @param {string} [tagName='div'] The type of element to create
-     * @returns {PseudoElement}
+     * @param tagName The type of element to create
      */
     createElement(tagName?: string): PseudoElement;
     /**
      * Make a text node which belongs to this document.
-     * @param {string} [data=''] The text
-     * @returns {TextService}
+     * @param data The text
      */
     createTextNode(data?: string): TextService;
     /**
      * Make a comment which belongs to this document.
-     * @param {string} [data=''] The comment
-     * @returns {CommentService}
+     * @param data The comment
      */
     createComment(data?: string): CommentService;
     /**
      * Make an empty document fragment which belongs to this document, a container for nodes which can be built up and
      * then inserted in one go.
-     * @returns {DocumentFragmentService}
      */
     createDocumentFragment(): DocumentFragmentService;
 }

package/dist/services/DocumentService.js

@@ -17,9 +17,6 @@ const DocumentFragmentService_1 = require('./DocumentFragmentService')
 const getElementById_1 = __importDefault(require('../functions/getElementById'))
 /**
  * Simulate the behaviour of the Document Class when there is no DOM available.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @class
- * @augments NodeService
  */
 class DocumentService extends NodeService_1.NodeService {
   get nodeName () {
@@ -38,8 +35,7 @@ class DocumentService extends NodeService_1.NodeService {
   set textContent (text) {}
   /**
    * The first element, in tree order, whose id matches the given value, or null when there is none.
-   * @param {string} id
-   * @returns {PseudoElement|null}
+   * @param id
    */
   getElementById (id) {
     return (0, getElementById_1.default)(this, id)
@@ -47,8 +43,7 @@ class DocumentService extends NodeService_1.NodeService {
 
   /**
    * Make an element of the given type which belongs to this document but is not added anywhere until it is appended.
-   * @param {string} [tagName='div'] The type of element to create
-   * @returns {PseudoElement}
+   * @param tagName The type of element to create
    */
   createElement (tagName = 'div') {
     // Like the DOM, the new element is not added anywhere: it has no parent until it is appended
@@ -61,8 +56,7 @@ class DocumentService extends NodeService_1.NodeService {
 
   /**
    * Make a text node which belongs to this document.
-   * @param {string} [data=''] The text
-   * @returns {TextService}
+   * @param data The text
    */
   createTextNode (data = '') {
     const text = new NodeService_1.TextService(data)
@@ -72,8 +66,7 @@ class DocumentService extends NodeService_1.NodeService {
 
   /**
    * Make a comment which belongs to this document.
-   * @param {string} [data=''] The comment
-   * @returns {CommentService}
+   * @param data The comment
    */
   createComment (data = '') {
     const comment = new NodeService_1.CommentService(data)
@@ -84,7 +77,6 @@ class DocumentService extends NodeService_1.NodeService {
   /**
    * Make an empty document fragment which belongs to this document, a container for nodes which can be built up and
    * then inserted in one go.
-   * @returns {DocumentFragmentService}
    */
   createDocumentFragment () {
     const fragment = new DocumentFragmentService_1.DocumentFragmentService()