pseudo-dom 0.17.0 → 1.0.0

package/dist/factories/generateDocument.js

@@ -18,21 +18,14 @@ const PseudoHTMLDocument_1 = __importDefault(require('../classes/PseudoHTMLDocum
 /**
  * Construct the Pseudo Dom to provide access to Dom objects which are otherwise not available outside the browser
  * context.
- * @function generateDocument
- * @param {Object} root
- * @param {Object} context
- * @returns {Window|PseudoEventTarget}
+ * @param root
+ * @param context
  */
 const generateDocument = (root, context = {}) => {
-  /**
-   *
-   * @type {Window|PseudoEventTarget}
-   */
   const newWindow = typeof root.document === 'undefined' ? root : new EventTargetService_1.default()
   /**
    * The Node class itself (matching the DOM's window.Node), not an instance - the right-hand side of `instanceof`
    * must be a constructor, so `x instanceof Node` needs this, not `new PseudoNode()`.
-   * @type {Function}
    */
   const Node = root.Node || NodeService_1.NodeService
   if (typeof newWindow.Node === 'undefined') {
@@ -40,7 +33,6 @@ const generateDocument = (root, context = {}) => {
   }
   /**
    * The Element class itself, for the same reason as Node.
-   * @type {Function}
    */
   const Element = root.Element || ElementService_1.ElementService
   if (typeof newWindow.Element === 'undefined') {
@@ -48,7 +40,6 @@ const generateDocument = (root, context = {}) => {
   }
   /**
    * The HTMLElement class itself, for the same reason as Node.
-   * @type {Function}
    */
   const HTMLElement = root.HTMLElement || HTMLElementService_1.HTMLElementService
   if (typeof newWindow.HTMLElement === 'undefined') {
@@ -57,7 +48,6 @@ const generateDocument = (root, context = {}) => {
   /**
    * The HTMLDocument class itself, for the same reason as Node (so `document instanceof HTMLDocument`, a common
    * real-DOM-detection check, works).
-   * @type {Function}
    */
   const HTMLDocument = root.HTMLDocument || PseudoHTMLDocument_1.default
   if (typeof newWindow.HTMLDocument === 'undefined') {
@@ -66,7 +56,6 @@ const generateDocument = (root, context = {}) => {
   /**
    * Define document when not available - a real instance, unlike the classes above (window.document IS an object,
    * not a constructor).
-   * @type {Document|PseudoHTMLDocument}
    */
   const document = root.document || new PseudoHTMLDocument_1.default()
   if (typeof newWindow.document === 'undefined') {

package/dist/factories/generateNodeList.d.ts

@@ -2,8 +2,7 @@ import { PseudoNodeList } from '../classes/PseudoNodeList';
 import { TreeLinker } from 'collect-your-stuff/dist/collections/linked-tree-list/TreeLinker';
 /**
  * Create a PseudoNodeList, optionally starting from an existing chain of linkers.
- * @param {TreeLinker|null} [innerList=null]
- * @returns {PseudoNodeList}
+ * @param innerList
  */
 declare const generateNodeList: (innerList?: TreeLinker | null) => PseudoNodeList;
 export default generateNodeList;

package/dist/factories/generateNodeList.js

@@ -6,8 +6,7 @@ Object.defineProperty(exports, '__esModule', {
 const PseudoNodeList_1 = require('../classes/PseudoNodeList')
 /**
  * Create a PseudoNodeList, optionally starting from an existing chain of linkers.
- * @param {TreeLinker|null} [innerList=null]
- * @returns {PseudoNodeList}
+ * @param innerList
  */
 const generateNodeList = (innerList = null) => new PseudoNodeList_1.PseudoNodeList().initialize(innerList)
 exports.default = generateNodeList

package/dist/factories/installGlobal.d.ts

@@ -6,10 +6,9 @@
  * real browser's global scope - some code checks for a bare `window` before falling back to `global`), so code
  * written against a real DOM's globals works as-is. Does nothing when a real DOM is already there, matching
  * generateDocument's own only-fill-what-is-missing behaviour - calling this is always safe, in any environment.
- * @memberOf module:factories
- * @param {*} [target] The object to add document / Node / Element / HTMLElement / window onto - defaults to
+ * @param target The object to add document / Node / Element / HTMLElement / window onto - defaults to
  * globalThis, so bare `document`, `Node`, `window`, etc. resolve from anywhere once this has run
- * @returns {*} The same target, for convenience
+ * @returns The same target, for convenience
  */
 declare const installGlobal: (target?: any) => any;
 export default installGlobal;

package/dist/factories/installGlobal.js

@@ -11,11 +11,9 @@ Object.defineProperty(exports, '__esModule', {
   value: true
 })
 /**
- * @file Makes pseudo-dom a drop-in swap for a real DOM: code written against bare globals (document.createElement,
+ * Makes pseudo-dom a drop-in swap for a real DOM: code written against bare globals (document.createElement,
  * new Node(), ...) works unmodified, in the browser or in Node, without an if (typeof document === 'undefined')
  * check at every call site.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.0.0
  */
 const browser_or_node_1 = require('browser-or-node')
 const generateDocument_1 = __importDefault(require('./generateDocument'))
@@ -27,10 +25,9 @@ const generateDocument_1 = __importDefault(require('./generateDocument'))
  * real browser's global scope - some code checks for a bare `window` before falling back to `global`), so code
  * written against a real DOM's globals works as-is. Does nothing when a real DOM is already there, matching
  * generateDocument's own only-fill-what-is-missing behaviour - calling this is always safe, in any environment.
- * @memberOf module:factories
- * @param {*} [target] The object to add document / Node / Element / HTMLElement / window onto - defaults to
+ * @param target The object to add document / Node / Element / HTMLElement / window onto - defaults to
  * globalThis, so bare `document`, `Node`, `window`, etc. resolve from anywhere once this has run
- * @returns {*} The same target, for convenience
+ * @returns The same target, for convenience
  */
 const installGlobal = (target = typeof globalThis !== 'undefined' ? globalThis : {}) => {
   if (!browser_or_node_1.isBrowser) {

package/dist/factories/logElement.d.ts

@@ -1,9 +1,7 @@
 /**
  * Print a node's markup to the console, indented for readability (see prettyPrint).
- * @memberOf module:factories
- * @param {*} node
- * @param {string} [label=''] A label printed above the markup, to identify this log call
- * @returns {undefined}
+ * @param node
+ * @param label A label printed above the markup, to identify this log call
  */
 declare const logElement: (node: any, label?: string) => void;
 export default logElement;

package/dist/factories/logElement.js

@@ -4,18 +4,14 @@ Object.defineProperty(exports, '__esModule', {
   value: true
 })
 /**
- * @file Prints an element (or any node) to the console, readably - the point of pseudo-dom running headlessly is
+ * Prints an element (or any node) to the console, readably - the point of pseudo-dom running headlessly is
  * usually to watch what code does to a tree without a real browser to look at.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.0.0
  */
 const serializeHTML_1 = require('./serializeHTML')
 /**
  * Print a node's markup to the console, indented for readability (see prettyPrint).
- * @memberOf module:factories
- * @param {*} node
- * @param {string} [label=''] A label printed above the markup, to identify this log call
- * @returns {undefined}
+ * @param node
+ * @param label A label printed above the markup, to identify this log call
  */
 const logElement = (node, label = '') => {
   console.log(`${label ? `${label}\n` : ''}${(0, serializeHTML_1.prettyPrint)(node)}`)

package/dist/factories/parseHTML.d.ts

@@ -1,11 +1,9 @@
 /**
  * Parse an HTML string into the nodes it describes (siblings at the top level, exactly like the DOM's own HTML
  * parsing does for innerHTML / insertAdjacentHTML - there is no single root unless the markup itself has one).
- * @memberOf module:factories
- * @param {string} html
- * @param {*} ownerDocument The document the new nodes belong to (matches what innerHTML etc. would set), or null
- * @param {function(new: *, {tagName: string})} ElementClass The class to build each parsed element with
- * @returns {Array<*>}
+ * @param html
+ * @param ownerDocument The document the new nodes belong to (matches what innerHTML etc. would set), or null
+ * @param ElementClass The class to build each parsed element with
  */
 declare const parseHTML: (html: string, ownerDocument: any, ElementClass: new (options: {
     tagName: string;

package/dist/factories/parseHTML.js

@@ -4,7 +4,7 @@ Object.defineProperty(exports, '__esModule', {
   value: true
 })
 /**
- * @file Parses an HTML string into pseudo-dom nodes, for innerHTML / outerHTML / insertAdjacentHTML. Built on
+ * Parses an HTML string into pseudo-dom nodes, for innerHTML / outerHTML / insertAdjacentHTML. Built on
  * htmlparser2's Parser (a SAX-style tokenizer) with a custom handler which builds pseudo-dom nodes directly -
  * htmlparser2's own default DomHandler / domutils tree (which this never uses) is stubbed out of the browser bundle
  * by the browser.ignore config, the same way css-select's unused default adapter already is.
@@ -12,19 +12,15 @@ Object.defineProperty(exports, '__esModule', {
  * The class to build parsed elements with is given by the caller (rather than imported here) so this has no
  * dependency on ElementService / HTMLElementService - importing either here, from a factory ElementService itself
  * would need to call, would create an import cycle.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.0.0
  */
 const htmlparser2_1 = require('htmlparser2')
 const NodeService_1 = require('../services/NodeService')
 /**
  * Parse an HTML string into the nodes it describes (siblings at the top level, exactly like the DOM's own HTML
  * parsing does for innerHTML / insertAdjacentHTML - there is no single root unless the markup itself has one).
- * @memberOf module:factories
- * @param {string} html
- * @param {*} ownerDocument The document the new nodes belong to (matches what innerHTML etc. would set), or null
- * @param {function(new: *, {tagName: string})} ElementClass The class to build each parsed element with
- * @returns {Array<*>}
+ * @param html
+ * @param ownerDocument The document the new nodes belong to (matches what innerHTML etc. would set), or null
+ * @param ElementClass The class to build each parsed element with
  */
 const parseHTML = (html, ownerDocument, ElementClass) => {
   const roots = []

package/dist/factories/query.d.ts

@@ -1,33 +1,25 @@
 /**
  * All of the elements below (not including) scope which match the selector, in tree order.
- * @memberOf module:factories
- * @param {string} selector A CSS selector
- * @param {*} scope The node to search below
- * @returns {Array<*>}
+ * @param selector A CSS selector
+ * @param scope The node to search below
  */
 export declare const querySelectorAll: (selector: string, scope: any) => Array<any>;
 /**
  * The first element below (not including) scope which matches the selector, in tree order, or null when there is none.
- * @memberOf module:factories
- * @param {string} selector A CSS selector
- * @param {*} scope The node to search below
- * @returns {*|null}
+ * @param selector A CSS selector
+ * @param scope The node to search below
  */
 export declare const querySelector: (selector: string, scope: any) => any | null;
 /**
  * Whether an element itself (not its descendants) matches the selector.
- * @memberOf module:factories
- * @param {*} element The element to test
- * @param {string} selector A CSS selector
- * @returns {boolean}
+ * @param element The element to test
+ * @param selector A CSS selector
  */
 export declare const matches: (element: any, selector: string) => boolean;
 /**
  * The nearest ancestor of an element (starting with the element itself) which matches the selector, or null when
  * none of them do.
- * @memberOf module:factories
- * @param {*} element The element to start from
- * @param {string} selector A CSS selector
- * @returns {*|null}
+ * @param element The element to start from
+ * @param selector A CSS selector
  */
 export declare const closest: (element: any, selector: string) => any | null;

package/dist/factories/query.js

@@ -5,19 +5,15 @@ Object.defineProperty(exports, '__esModule', {
 })
 exports.closest = exports.matches = exports.querySelector = exports.querySelectorAll = void 0
 /**
- * @file Selector queries (querySelector, querySelectorAll, matches, closest), built on css-select and the
+ * Selector queries (querySelector, querySelectorAll, matches, closest), built on css-select and the
  * cssSelectAdapter which lets it query pseudo-dom's own tree.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.0.0
  */
 const css_select_1 = require('css-select')
 const cssSelectAdapter_1 = require('./cssSelectAdapter')
 /**
  * All of the elements below (not including) scope which match the selector, in tree order.
- * @memberOf module:factories
- * @param {string} selector A CSS selector
- * @param {*} scope The node to search below
- * @returns {Array<*>}
+ * @param selector A CSS selector
+ * @param scope The node to search below
  */
 const querySelectorAll = (selector, scope) => (0, css_select_1.selectAll)(selector, scope, {
   adapter: cssSelectAdapter_1.cssSelectAdapter
@@ -25,10 +21,8 @@ const querySelectorAll = (selector, scope) => (0, css_select_1.selectAll)(select
 exports.querySelectorAll = querySelectorAll
 /**
  * The first element below (not including) scope which matches the selector, in tree order, or null when there is none.
- * @memberOf module:factories
- * @param {string} selector A CSS selector
- * @param {*} scope The node to search below
- * @returns {*|null}
+ * @param selector A CSS selector
+ * @param scope The node to search below
  */
 const querySelector = (selector, scope) => (0, css_select_1.selectOne)(selector, scope, {
   adapter: cssSelectAdapter_1.cssSelectAdapter
@@ -36,10 +30,8 @@ const querySelector = (selector, scope) => (0, css_select_1.selectOne)(selector,
 exports.querySelector = querySelector
 /**
  * Whether an element itself (not its descendants) matches the selector.
- * @memberOf module:factories
- * @param {*} element The element to test
- * @param {string} selector A CSS selector
- * @returns {boolean}
+ * @param element The element to test
+ * @param selector A CSS selector
  */
 const matches = (element, selector) => (0, css_select_1.is)(element, selector, {
   adapter: cssSelectAdapter_1.cssSelectAdapter
@@ -48,10 +40,8 @@ exports.matches = matches
 /**
  * The nearest ancestor of an element (starting with the element itself) which matches the selector, or null when
  * none of them do.
- * @memberOf module:factories
- * @param {*} element The element to start from
- * @param {string} selector A CSS selector
- * @returns {*|null}
+ * @param element The element to start from
+ * @param selector A CSS selector
  */
 const closest = (element, selector) => {
   let current = element

package/dist/factories/serializeHTML.d.ts

@@ -1,25 +1,19 @@
 /**
  * A node's children, serialized in order (this is what innerHTML returns).
- * @memberOf module:factories
- * @param {*} node
- * @returns {string}
+ * @param node
  */
 declare const serializeChildren: (node: any) => string;
 /**
  * An element itself, serialized with its children (this is what outerHTML returns).
- * @memberOf module:factories
- * @param {*} element
- * @returns {string}
+ * @param element
  */
 declare const serializeOuter: (element: any) => string;
 /**
  * A node's markup, indented one level per level of nesting - a real DOM's outerHTML / innerHTML has no line breaks
  * at all, which does not read well for a whole tree (a board full of cells, say). Useful for watching pseudo-dom-
  * driven code run headlessly, printed to a terminal - see also logElement, which does the printing too.
- * @memberOf module:factories
- * @param {*} node
- * @param {string} [indent='  '] The indentation used per level of nesting
- * @returns {string}
+ * @param node
+ * @param indent The indentation used per level of nesting
  */
 declare const prettyPrint: (node: any, indent?: string) => string;
 export { serializeChildren, serializeOuter, prettyPrint };

package/dist/factories/serializeHTML.js

@@ -24,9 +24,7 @@ Object.defineProperty(exports, '__esModule', {
 })
 exports.prettyPrint = exports.serializeOuter = exports.serializeChildren = void 0
 /**
- * @file Serializes pseudo-dom nodes back into an HTML string, for innerHTML / outerHTML.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.0.0
+ * Serializes pseudo-dom nodes back into an HTML string, for innerHTML / outerHTML.
  */
 const NodeService_1 = require('../services/NodeService')
 // Void elements are self-closing and never serialize a closing tag or children (there is no HTML parsing of their
@@ -46,23 +44,20 @@ const BOOLEAN_ATTRIBUTES = new Set(['hidden'])
  * Escape text so it is safe inside HTML text content. Coerces to a string first - unlike a real DOM, pseudo-dom's
  * setAttribute does not itself coerce (see the same note on escapeAttributeValue), and nodeValue is not guaranteed
  * to be a string either.
- * @param {*} text
- * @returns {string}
+ * @param text
  */
 const escapeText = text => String(text).replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;')
 /**
  * Escape a value so it is safe inside a double-quoted HTML attribute. Coerces to a string first: a real DOM's
  * setAttribute always stores a string, however pseudo-dom's does not coerce what it is given, so a value set via
  * setAttribute(name, 5) is stored (and read back by getAttribute) as the number 5, not the string '5'.
- * @param {*} value
- * @returns {string}
+ * @param value
  */
 const escapeAttributeValue = value => String(value).replace(/&/g, '&amp;').replace(/"/g, '&quot;')
 /**
  * Every attribute of the element, serialized (class instead of className, boolean attributes bare, the never-real
  * mock properties left out, style added from the live CSSStyleDeclaration when it is not empty).
- * @param {*} element
- * @returns {string}
+ * @param element
  */
 const serializeAttributes = element => {
   let result = (element.getAttributeNames ? element.getAttributeNames() : []).filter(name => !NEVER_SERIALIZE.has(name)).map(name => {
@@ -80,8 +75,7 @@ const serializeAttributes = element => {
 }
 /**
  * One node, serialized (its own markup only - see serializeChildren for its descendants too).
- * @param {*} node
- * @returns {string}
+ * @param node
  */
 const serializeNode = node => {
   if (node.nodeType === NodeService_1.NodeService.TEXT_NODE) {
@@ -102,27 +96,22 @@ const serializeNode = node => {
 }
 /**
  * A node's children, serialized in order (this is what innerHTML returns).
- * @memberOf module:factories
- * @param {*} node
- * @returns {string}
+ * @param node
  */
 const serializeChildren = node => Array.from(node.childNodes).map(serializeNode).join('')
 exports.serializeChildren = serializeChildren
 /**
  * An element itself, serialized with its children (this is what outerHTML returns).
- * @memberOf module:factories
- * @param {*} element
- * @returns {string}
+ * @param element
  */
 const serializeOuter = element => serializeNode(element)
 exports.serializeOuter = serializeOuter
 /**
  * One node, indented for readability (see prettyPrint) - unlike serializeNode, every non-empty node is its own
  * line, so the structure of a whole tree is easy to read at a glance.
- * @param {*} node
- * @param {number} depth
- * @param {string} indent
- * @returns {string}
+ * @param node
+ * @param depth
+ * @param indent
  */
 const prettyPrintNode = (node, depth, indent) => {
   const pad = indent.repeat(depth)
@@ -151,10 +140,8 @@ const prettyPrintNode = (node, depth, indent) => {
  * A node's markup, indented one level per level of nesting - a real DOM's outerHTML / innerHTML has no line breaks
  * at all, which does not read well for a whole tree (a board full of cells, say). Useful for watching pseudo-dom-
  * driven code run headlessly, printed to a terminal - see also logElement, which does the printing too.
- * @memberOf module:factories
- * @param {*} node
- * @param {string} [indent='  '] The indentation used per level of nesting
- * @returns {string}
+ * @param node
+ * @param indent The indentation used per level of nesting
  */
 const prettyPrint = (node, indent = '  ') => prettyPrintNode(node, 0, indent)
 exports.prettyPrint = prettyPrint

package/dist/functions/activeElement.d.ts

@@ -1,14 +1,11 @@
 /**
  * Find the element which has the focus in a tree.
- * @function getActiveElement
- * @param {Object} root The root node of the tree
- * @returns {Object|null}
+ * @param root The root node of the tree
  */
 export declare const getActiveElement: (root: object) => any | null;
 /**
  * Remember the element which has the focus in a tree.
- * @function setActiveElement
- * @param {Object} root The root node of the tree
- * @param {Object|null} element The element which now has the focus, or null when nothing has it
+ * @param root The root node of the tree
+ * @param element The element which now has the focus, or null when nothing has it
  */
 export declare const setActiveElement: (root: object, element: any | null) => void;

package/dist/functions/activeElement.js

@@ -11,17 +11,14 @@ exports.setActiveElement = exports.getActiveElement = void 0
 const focused = new WeakMap()
 /**
  * Find the element which has the focus in a tree.
- * @function getActiveElement
- * @param {Object} root The root node of the tree
- * @returns {Object|null}
+ * @param root The root node of the tree
  */
 const getActiveElement = root => focused.get(root) || null
 exports.getActiveElement = getActiveElement
 /**
  * Remember the element which has the focus in a tree.
- * @function setActiveElement
- * @param {Object} root The root node of the tree
- * @param {Object|null} element The element which now has the focus, or null when nothing has it
+ * @param root The root node of the tree
+ * @param element The element which now has the focus, or null when nothing has it
  */
 const setActiveElement = (root, element) => {
   if (element === null) {

package/dist/functions/getElementById.d.ts

@@ -4,10 +4,8 @@ import { PseudoElement } from '../interfaces/PseudoElement';
  * The first element, in tree order, below (not including) the given node whose id matches the given value, or null
  * when there is none. Shared by Document and DocumentFragment, which both implement the DOM's NonElementParentNode
  * mixin (so ShadowRoot, a DocumentFragment, gets it too).
- * @memberOf module:functions
- * @param {NodeService} root The node to search below
- * @param {string} id
- * @returns {PseudoElement|null}
+ * @param root The node to search below
+ * @param id
  */
 declare const getElementById: (root: NodeService, id: string) => PseudoElement | null;
 export default getElementById;

package/dist/functions/getElementById.js

@@ -8,10 +8,8 @@ const NodeService_1 = require('../services/NodeService')
  * The first element, in tree order, below (not including) the given node whose id matches the given value, or null
  * when there is none. Shared by Document and DocumentFragment, which both implement the DOM's NonElementParentNode
  * mixin (so ShadowRoot, a DocumentFragment, gets it too).
- * @memberOf module:functions
- * @param {NodeService} root The node to search below
- * @param {string} id
- * @returns {PseudoElement|null}
+ * @param root The node to search below
+ * @param id
  */
 const getElementById = (root, id) => {
   const search = node => {

package/dist/functions/getParentNodes.d.ts

@@ -3,9 +3,7 @@ import { PseudoEventTarget } from '../interfaces/PseudoEventTarget';
 /**
  * Get all of the ancestors of a node, starting with the root of the tree and ending with the node's own parent (the
  * order in which an event travels down through them). A node which has no parent has no ancestors.
- * @function getParentNodes
- * @param {PseudoEventTarget|PseudoNode|*} node The node to find the ancestors of
- * @returns {Array<PseudoNode>}
+ * @param node The node to find the ancestors of
  */
 declare const getParentNodes: (node: PseudoEventTarget | PseudoNode | any) => Array<PseudoNode>;
 export default getParentNodes;

package/dist/functions/getParentNodes.js

@@ -6,9 +6,7 @@ Object.defineProperty(exports, '__esModule', {
 /**
  * Get all of the ancestors of a node, starting with the root of the tree and ending with the node's own parent (the
  * order in which an event travels down through them). A node which has no parent has no ancestors.
- * @function getParentNodes
- * @param {PseudoEventTarget|PseudoNode|*} node The node to find the ancestors of
- * @returns {Array<PseudoNode>}
+ * @param node The node to find the ancestors of
  */
 const getParentNodes = node => {
   const parents = []

package/dist/functions/getParentNodesFromAttribute.d.ts

@@ -4,11 +4,9 @@ import { PseudoEventTarget } from '../interfaces/PseudoEventTarget';
  * A selector function for retrieving existing parent PseudoNode from the given child item.
  * This function will check all the parents starting from node, and scan the attributes
  * property for matches. The return array contains all matching parent ancestors, starting with the root of the tree.
- * @function getParentNodesFromAttribute
- * @param {string} attr The property to compare on each ancestor (a missing property counts as false)
- * @param {boolean|number|string} value The value the property must have
- * @param {PseudoEventTarget|PseudoNode|*} node The node to find the matching ancestors of
- * @returns {Array.<PseudoNode>}
+ * @param attr The property to compare on each ancestor (a missing property counts as false)
+ * @param value The value the property must have
+ * @param node The node to find the matching ancestors of
  */
 declare const getParentNodesFromAttribute: (attr: string, value: boolean | number | string, node: PseudoEventTarget | PseudoNode | any) => Array<PseudoNode>;
 export default getParentNodesFromAttribute;

package/dist/functions/getParentNodesFromAttribute.js

@@ -17,11 +17,9 @@ const getParentNodes_1 = __importDefault(require('./getParentNodes'))
  * A selector function for retrieving existing parent PseudoNode from the given child item.
  * This function will check all the parents starting from node, and scan the attributes
  * property for matches. The return array contains all matching parent ancestors, starting with the root of the tree.
- * @function getParentNodesFromAttribute
- * @param {string} attr The property to compare on each ancestor (a missing property counts as false)
- * @param {boolean|number|string} value The value the property must have
- * @param {PseudoEventTarget|PseudoNode|*} node The node to find the matching ancestors of
- * @returns {Array.<PseudoNode>}
+ * @param attr The property to compare on each ancestor (a missing property counts as false)
+ * @param value The value the property must have
+ * @param node The node to find the matching ancestors of
  */
 const getParentNodesFromAttribute = (attr, value, node) => {
   return (0, getParentNodes_1.default)(node).filter(parent => (parent[attr] || false) === value)

package/dist/functions/modifierState.d.ts

@@ -1,10 +1,5 @@
 /**
  * The modifier keys which were held down when a mouse or keyboard event happened.
- * @typedef {Object} ModifierKeys
- * @property {boolean} ctrlKey
- * @property {boolean} shiftKey
- * @property {boolean} altKey
- * @property {boolean} metaKey
  */
 export type ModifierKeys = {
     ctrlKey: boolean;
@@ -14,16 +9,12 @@ export type ModifierKeys = {
 };
 /**
  * Pick the modifier keys out of the init object of an event.
- * @function modifierKeys
- * @param {Object} [init={}] The init of an event
- * @returns {ModifierKeys}
+ * @param init The init of an event
  */
 export declare const modifierKeys: (init?: any) => ModifierKeys;
 /**
  * Answer getModifierState for a set of held modifier keys.
- * @function modifierState
- * @param {ModifierKeys} keys The modifier keys which were held down
- * @param {string} key The name of the modifier (Control, Shift, Alt or Meta)
- * @returns {boolean}
+ * @param keys The modifier keys which were held down
+ * @param key The name of the modifier (Control, Shift, Alt or Meta)
  */
 export declare const modifierState: (keys: ModifierKeys, key: string) => boolean;

package/dist/functions/modifierState.js

@@ -6,9 +6,7 @@ Object.defineProperty(exports, '__esModule', {
 exports.modifierState = exports.modifierKeys = void 0
 /**
  * Pick the modifier keys out of the init object of an event.
- * @function modifierKeys
- * @param {Object} [init={}] The init of an event
- * @returns {ModifierKeys}
+ * @param init The init of an event
  */
 const modifierKeys = (init = {}) => ({
   ctrlKey: !!init.ctrlKey,
@@ -19,10 +17,8 @@ const modifierKeys = (init = {}) => ({
 exports.modifierKeys = modifierKeys
 /**
  * Answer getModifierState for a set of held modifier keys.
- * @function modifierState
- * @param {ModifierKeys} keys The modifier keys which were held down
- * @param {string} key The name of the modifier (Control, Shift, Alt or Meta)
- * @returns {boolean}
+ * @param keys The modifier keys which were held down
+ * @param key The name of the modifier (Control, Shift, Alt or Meta)
  */
 const modifierState = (keys, key) => {
   switch (key) {

package/dist/interfaces/PseudoCSSStyleDeclaration.d.ts

@@ -1,5 +1,5 @@
 /**
- * @file Substitute for the DOM CSSStyleDeclaration Class. Real instances (from createStyleDeclaration) also accept
+ * Substitute for the DOM CSSStyleDeclaration Class. Real instances (from createStyleDeclaration) also accept
  * arbitrary camelCase CSS property names (declaration.backgroundColor), which cannot be expressed in an interface.
  */
 export interface PseudoCSSStyleDeclaration {