API documentation updates

packages/node_modules/@node-red/util/lib/util.js

@@ -15,10 +15,9 @@
  * @ignore
  **/
 
- /**
-  * @module util
-  * @memberof module:@node-red/util
-  */
+/**
+ * @mixin @node-red/util_util
+ */
 
 
 const clone = require("clone");
@@ -29,7 +28,7 @@ const util = require("util");
 /**
  * Generates a psuedo-unique-random id.
  * @return {String} a random-ish id
- * @memberof module:@node-red/util.module:util
+ * @memberof @node-red/util_util
  */
 function generateId() {
     return (1+Math.random()*4294967295).toString(16);
@@ -41,7 +40,7 @@ function generateId() {
  *
  * @param  {any}    o - the property to convert to a String
  * @return {String} the stringified version
- * @memberof module:@node-red/util.module:util
+ * @memberof @node-red/util_util
  */
 function ensureString(o) {
     if (Buffer.isBuffer(o)) {
@@ -60,7 +59,7 @@ function ensureString(o) {
  *
  * @param  {any}    o - the property to convert to a Buffer
  * @return {String} the Buffer version
- * @memberof module:@node-red/util.module:util
+ * @memberof @node-red/util_util
  */
 function ensureBuffer(o) {
     if (Buffer.isBuffer(o)) {
@@ -79,7 +78,7 @@ function ensureBuffer(o) {
  *
  * @param  {any}    msg - the message object to clone
  * @return {Object} the cloned message
- * @memberof module:@node-red/util.module:util
+ * @memberof @node-red/util_util
  */
 function cloneMessage(msg) {
     // Temporary fix for #97
@@ -106,7 +105,7 @@ function cloneMessage(msg) {
  * @param  {any}    obj1
  * @param  {any}    obj2
  * @return {boolean} whether the two objects are the same
- * @memberof module:@node-red/util.module:util
+ * @memberof @node-red/util_util
  */
 function compareObjects(obj1,obj2) {
     var i;
@@ -189,7 +188,7 @@ function createError(code, message) {
  *
  * @param  {String} str - the property expression
  * @return {Array} the normalised expression
- * @memberof module:@node-red/util.module:util
+ * @memberof @node-red/util_util
  */
 function normalisePropertyExpression(str) {
     // This must be kept in sync with validatePropertyExpression
@@ -304,7 +303,7 @@ function normalisePropertyExpression(str) {
  * @param  {Object} msg - the message object
  * @param  {String} str - the property expression
  * @return {any} the message property, or undefined if it does not exist
- * @memberof module:@node-red/util.module:util
+ * @memberof @node-red/util_util
  */
 function getMessageProperty(msg,expr) {
     if (expr.indexOf('msg.')===0) {
@@ -319,7 +318,7 @@ function getMessageProperty(msg,expr) {
  * @param  {Object} msg - the object
  * @param  {String} str - the property expression
  * @return {any} the object property, or undefined if it does not exist
- * @memberof module:@node-red/util.module:util
+ * @memberof @node-red/util_util
  */
 function getObjectProperty(msg,expr) {
     var result = null;
@@ -342,7 +341,7 @@ function getObjectProperty(msg,expr) {
  * @param  {String}  prop          - the property expression
  * @param  {any}     value         - the value to set
  * @param  {boolean} createMissing - whether to create missing parent properties
- * @memberof module:@node-red/util.module:util
+ * @memberof @node-red/util_util
  */
 function setMessageProperty(msg,prop,value,createMissing) {
     if (prop.indexOf('msg.')===0) {
@@ -358,7 +357,7 @@ function setMessageProperty(msg,prop,value,createMissing) {
  * @param  {String}  prop          - the property expression
  * @param  {any}     value         - the value to set
  * @param  {boolean} createMissing - whether to create missing parent properties
- * @memberof module:@node-red/util.module:util
+ * @memberof @node-red/util_util
  */
 function setObjectProperty(msg,prop,value,createMissing) {
     if (typeof createMissing === 'undefined') {
@@ -422,7 +421,7 @@ function setObjectProperty(msg,prop,value,createMissing) {
  * will return `Hello Joe!`.
  * @param  {String} value - the string to parse
  * @return {String} The parsed string
-* @memberof module:@node-red/util.module:util
+* @memberof @node-red/util_util
  */
 function evaluateEnvProperty(value) {
     if (/^\${[^}]+}$/.test(value)) {
@@ -450,7 +449,7 @@ function evaluateEnvProperty(value) {
  *
  * @param  {String} value - the context property string to parse
  * @return {Object} The parsed property
- * @memberof module:@node-red/util.module:util
+ * @memberof @node-red/util_util
  */
 function parseContextStore(key) {
     var parts = {};
@@ -474,7 +473,7 @@ function parseContextStore(key) {
  * @param  {Object}   msg      - the message object to evaluate against
  * @param  {Function} callback - (optional) called when the property is evaluated
  * @return {any} The evaluted property, if no `callback` is provided
- * @memberof module:@node-red/util.module:util
+ * @memberof @node-red/util_util
  */
 function evaluateNodeProperty(value, type, node, msg, callback) {
     var result = value;
@@ -531,7 +530,7 @@ function evaluateNodeProperty(value, type, node, msg, callback) {
  * @param  {String} value - the JSONata expression
  * @param  {Node}   node  - the node evaluating the property
  * @return {Object} The JSONata expression that can be evaluated
- * @memberof module:@node-red/util.module:util
+ * @memberof @node-red/util_util
  */
 function prepareJSONataExpression(value,node) {
     var expr = jsonata(value);
@@ -559,7 +558,7 @@ function prepareJSONataExpression(value,node) {
  * @param  {Object}   msg      - the message object to evaluate against
  * @param  {Function} callback - (optional) called when the expression is evaluated
  * @return {any} If no callback was provided, the result of the expression
- * @memberof module:@node-red/util.module:util
+ * @memberof @node-red/util_util
  */
 function evaluateJSONataExpression(expr,msg,callback) {
     var context = msg;
@@ -604,7 +603,7 @@ function evaluateJSONataExpression(expr,msg,callback) {
  *
  * @param  {String} name - the node type
  * @return {String} The normalised name
- * @memberof module:@node-red/util.module:util
+ * @memberof @node-red/util_util
  */
 function normaliseNodeTypeName(name) {
     var result = name.replace(/[^a-zA-Z0-9]/g, " ");
@@ -628,7 +627,7 @@ function normaliseNodeTypeName(name) {
  * @param  {Object} msg
  * @param {Object} opts
  * @return {Object} the encoded object
- * @memberof module:@node-red/util.module:util
+ * @memberof @node-red/util_util
  */
 function encodeObject(msg,opts) {
     var debuglength = 1000;