Renamed testIfVNodesDiffer to isSameNode.

1. Renamed testIfVNodesDiffer to isSameNode. Easier to say and write.
2. Updated JSDoc comments for h.
3. Updated JSDoc comments for Fragment.

Author: Robert Biggs

dist/composi.js.map

@@ -1,7 +1,7 @@
 import { patch } from './patch'
 import { mixin } from './utils/mixin'
 import { rAF } from './utils/rAF'
-import { testIfVNodesDiffer } from './utils/testIfVNodesDiffer'
+import { isSameNode } from './utils/isSameNode'
 
 /**
  * @description This is a Time Object used as a key to create a pseudo-private property in the Component class for holding state.
@@ -241,7 +241,7 @@ export class Component {
    * @method Function to render component after data changes.
    * If data is passed as argument, it will be used.
    * Otherwise state will be used.
-   * @param {boolean | number | string | Object | any[]} [data]
+   * @param {boolean | number | string | Object | any[]} [data] By default, data will be the component's current state, otherwise, if data is provided as an argument, that will be used, overriding the state.
    * @returns {void} undefined
    */
   update(data) {
@@ -279,7 +279,7 @@ export class Component {
       elem.parentNode.removeChild(elem)
     }
 
-    // Capture old node to use with testIfVNodesDiffer if component has already mounted:
+    // Capture old node to use with isSameNode if component has already mounted:
     const __oldNode = this.element && this.element.node
 
     /**
@@ -299,7 +299,7 @@ export class Component {
       return
     }
 
-    if (testIfVNodesDiffer(__oldNode, __data, this)) {
+    if (isSameNode(__oldNode, __data, this)) {
       this.componentWillUpdate && this.componentWillUpdate(this)
       this.componentDidUpdate && this.componentDidUpdate(this)
     }

lib/component.js

@@ -12,8 +12,8 @@
  *   h('li', {}, 'B'),
  *   h('li', {}, 'C')
  * ])
- * @param {null | Object} props When using Fragment as a function, props is the first argument. Provide either null or {} as the value for props.
- * @param {any[]} children The siblings to return with the Fragment. This will be an array of sibling elements.
+ * @param {{}} [props] When using Fragment as a function, props is the first argument. Provide either null or {} as the value for props.
+ * @param {any[]} [children] The siblings to return with the Fragment. This will be an array of sibling elements.
  * @returns {Object[]} An array of virtual nodes.
  */
 export const Fragment = (props, children) => children

lib/fragment.js

@@ -1,9 +1,17 @@
+/**
+ * @description A virtual node defining a node to be created. This gets returns by the h function.
+ * @typedef {Object} VNode
+ * @prop {string} type The node to create, such as "h1", "p", "div", etc.
+ * @prop {Object} [props] An object of key/value pairs defining properties and values for the node. These include properties such as "class", "id", "disabled", etc.
+ * @prop {any[] | null} [children] An array of children belonging to the node.
+ * @prop {string | number | undefined} [key] A unique key to identify a node.
+ */
 /**
  * @description Hyperscript function. Enables definition of HTML/SVG using functions.
  * @param {string | Function} type The name of the HTML or SVG tag to create or a function using an HTML tag name.
  * @param {Object} [props] An object of property/value pairs.
  * @param {any[]} [children] Any child elements.
- * @returns {Object} A virtual node describing an element.
+ * @returns {VNode} A virtual node describing an element.
  * @example Virtual node with string as content:
  * const title = h('h1', {class: 'main-title'}, 'This is the Titel!')
  * @example Virtual node with children:

lib/h.js

@@ -4,7 +4,7 @@
  * @param {*} data Data to be used when rendering a new virtual node for a component.
  * @param {Object} component A reference to the component being used.
  */
-export function testIfVNodesDiffer(oldNode, data, component) {
+export function isSameNode(oldNode, data, component) {
   if (
     component &&
     JSON.stringify(oldNode) === JSON.stringify(component.render(data))

lib/utils/testIfVNodesDiffer.js renamed to lib/utils/isSameNode.js

@@ -1,6 +1,6 @@
 {
   "name": "composi",
-  "version": "2.3.3",
+  "version": "2.3.4",
   "description": "A JavaScript library for creating websites, PWAs and hybrid apps.",
   "main": "index.js",
   "scripts": {