@node-red/util - npm Package Compare versions

Comparing version 0.20.0-alpha.0 to 0.20.0-beta.1

index.js

@@ -1,2 +0,2 @@
-/**
+/*!
  * Copyright JS Foundation and other contributors, http://js.foundation
@@ -17,5 +17,2 @@ *
 
- /**
-  * @module @node-red/util
-  */
 const log = require("./lib/log");
@@ -25,2 +22,7 @@ const i18n = require("./lib/i18n");
 
+/**
+ * This module provides common utilities for the Node-RED runtime and editor
+ *
+ * @namespace @node-red/util
+ */
 module.exports = {
@@ -30,2 +32,3 @@ /**
     * @param {Object} settings
+    * @memberof @node-red/util
     */
@@ -39,3 +42,4 @@ init: function(settings) {
     * Logging utilities
-    * @see module:@node-red/util.module:log
+    * @mixes @node-red/util_log
+    * @memberof @node-red/util
     */
@@ -46,3 +50,4 @@ log: log,
     * Internationalization utilities
-    * @see module:@node-red/util.module:i18n
+    * @mixes @node-red/util_i18n
+    * @memberof @node-red/util
     */
@@ -53,5 +58,6 @@ i18n: i18n,
     * General utilities
-    * @see module:@node-red/util.module:util
+    * @mixes @node-red/util_util
+    * @memberof @node-red/util
     */
     util: util,
 }

lib/i18n.js

@@ -18,6 +18,6 @@ /**
 
- /**
-  * @module i18n
-  * @memberof module:@node-red/util
-  */
+/**
+ * Internationalization utilities
+ * @mixin @node-red/util_i18n
+ */
 
@@ -38,3 +38,3 @@ var i18n = require("i18next");
  * Register multiple message catalogs with i18n.
- * @memberof module:@node-red/util.module:i18n
+ * @memberof @node-red/util_i18n
  */
@@ -50,3 +50,3 @@ function registerMessageCatalogs(catalogs) {
  * Register a message catalog with i18n.
- * @memberof module:@node-red/util.module:i18n
+ * @memberof @node-red/util_i18n
  */
@@ -152,3 +152,3 @@ function registerMessageCatalog(namespace,dir,file) {
  * @function
- * @memberof module:@node-red/util.module:i18n
+ * @memberof @node-red/util_i18n
  */
@@ -189,3 +189,3 @@ function getCatalog(namespace,lang) {
  * @function
- * @memberof module:@node-red/util.module:i18n
+ * @memberof @node-red/util_i18n
  */
@@ -192,0 +192,0 @@ obj['_'] = function() {

lib/log.js

@@ -19,4 +19,4 @@ /**
 /**
- * @module log
- * @memberof module:@node-red/util
+ * Logging utilities
+ * @mixin @node-red/util_log
  */
@@ -132,3 +132,4 @@
     /**
-     * Add a log handler function.
+     * Add a log handler function
+     * @memberof @node-red/util_log
      */
@@ -140,3 +141,4 @@ addHandler: function(func) {
     /**
-     * Remove a log handler function.
+     * Remove a log handler function
+     * @memberof @node-red/util_log
      */
@@ -151,3 +153,4 @@ removeHandler: function(func) {
     /**
-     * Log a message object.
+     * Log a message object
+     * @memberof @node-red/util_log
      */
@@ -162,3 +165,4 @@ log: function(msg) {
     /**
-     * Log a message at INFO level.
+     * Log a message at INFO level
+     * @memberof @node-red/util_log
      */
@@ -170,3 +174,4 @@ info: function(msg) {
     /**
-     * Log a message at WARN level.
+     * Log a message at WARN level
+     * @memberof @node-red/util_log
      */
@@ -178,3 +183,4 @@ warn: function(msg) {
     /**
-     * Log a message at ERROR level.
+     * Log a message at ERROR level
+     * @memberof @node-red/util_log
      */
@@ -186,3 +192,4 @@ error: function(msg) {
     /**
-     * Log a message at TRACE level.
+     * Log a message at TRACE level
+     * @memberof @node-red/util_log
      */
@@ -194,3 +201,4 @@ trace: function(msg) {
     /**
-     * Log a message at DEBUG level.
+     * Log a message at DEBUG level
+     * @memberof @node-red/util_log
      */
@@ -202,3 +210,4 @@ debug: function(msg) {
     /**
-     * Log a metric event.
+     * Check if metrics are enabled
+     * @memberof @node-red/util_log
      */
@@ -211,2 +220,3 @@ metric: function() {
      * Log an audit event.
+     * @memberof @node-red/util_log
      */
@@ -228,4 +238,4 @@ audit: function(msg,req) {
  * @function
- * @memberof module:@node-red/util.module:log
+ * @memberof @node-red/util_log
  */
 log["_"] = i18n._;

lib/util.js

@@ -18,6 +18,5 @@ /**
 
- /**
-  * @module util
-  * @memberof module:@node-red/util
-  */
+/**
+ * @mixin @node-red/util_util
+ */
 
@@ -33,3 +32,3 @@
  * @return {String} a random-ish id
- * @memberof module:@node-red/util.module:util
+ * @memberof @node-red/util_util
  */
@@ -46,3 +45,3 @@ function generateId() {
  * @return {String} the stringified version
- * @memberof module:@node-red/util.module:util
+ * @memberof @node-red/util_util
  */
@@ -66,3 +65,3 @@ function ensureString(o) {
  * @return {String} the Buffer version
- * @memberof module:@node-red/util.module:util
+ * @memberof @node-red/util_util
  */
@@ -86,3 +85,3 @@ function ensureBuffer(o) {
  * @return {Object} the cloned message
- * @memberof module:@node-red/util.module:util
+ * @memberof @node-red/util_util
  */
@@ -114,3 +113,3 @@ function cloneMessage(msg) {
  * @return {boolean} whether the two objects are the same
- * @memberof module:@node-red/util.module:util
+ * @memberof @node-red/util_util
  */
@@ -198,3 +197,3 @@ function compareObjects(obj1,obj2) {
  * @return {Array} the normalised expression
- * @memberof module:@node-red/util.module:util
+ * @memberof @node-red/util_util
  */
@@ -314,3 +313,3 @@ function normalisePropertyExpression(str) {
  * @return {any} the message property, or undefined if it does not exist
- * @memberof module:@node-red/util.module:util
+ * @memberof @node-red/util_util
  */
@@ -330,3 +329,3 @@ function getMessageProperty(msg,expr) {
  * @return {any} the object property, or undefined if it does not exist
- * @memberof module:@node-red/util.module:util
+ * @memberof @node-red/util_util
  */
@@ -354,3 +353,3 @@ function getObjectProperty(msg,expr) {
  * @param  {boolean} createMissing - whether to create missing parent properties
- * @memberof module:@node-red/util.module:util
+ * @memberof @node-red/util_util
  */
@@ -371,3 +370,3 @@ function setMessageProperty(msg,prop,value,createMissing) {
  * @param  {boolean} createMissing - whether to create missing parent properties
- * @memberof module:@node-red/util.module:util
+ * @memberof @node-red/util_util
  */
@@ -436,3 +435,3 @@ function setObjectProperty(msg,prop,value,createMissing) {
  * @return {String} The parsed string
-* @memberof module:@node-red/util.module:util
+* @memberof @node-red/util_util
  */
@@ -465,3 +464,3 @@ function evaluateEnvProperty(value) {
  * @return {Object} The parsed property
- * @memberof module:@node-red/util.module:util
+ * @memberof @node-red/util_util
  */
@@ -490,3 +489,3 @@ function parseContextStore(key) {
  * @return {any} The evaluted property, if no `callback` is provided
- * @memberof module:@node-red/util.module:util
+ * @memberof @node-red/util_util
  */
@@ -548,3 +547,3 @@ function evaluateNodeProperty(value, type, node, msg, callback) {
  * @return {Object} The JSONata expression that can be evaluated
- * @memberof module:@node-red/util.module:util
+ * @memberof @node-red/util_util
  */
@@ -577,3 +576,3 @@ function prepareJSONataExpression(value,node) {
  * @return {any} If no callback was provided, the result of the expression
- * @memberof module:@node-red/util.module:util
+ * @memberof @node-red/util_util
  */
@@ -623,3 +622,3 @@ function evaluateJSONataExpression(expr,msg,callback) {
  * @return {String} The normalised name
- * @memberof module:@node-red/util.module:util
+ * @memberof @node-red/util_util
  */
@@ -648,3 +647,3 @@ function normaliseNodeTypeName(name) {
  * @return {Object} the encoded object
- * @memberof module:@node-red/util.module:util
+ * @memberof @node-red/util_util
  */
@@ -651,0 +650,0 @@ function encodeObject(msg,opts) {

package.json

 {
     "name": "@node-red/util",
-    "version": "0.20.0-alpha.0",
+    "version": "0.20.0-beta.1",
     "license": "Apache-2.0",
@@ -10,8 +10,12 @@ "repository": {
     "contributors": [
-        { "name": "Nick O'Leary" },
-        { "name": "Dave Conway-Jones"}
+        {
+            "name": "Nick O'Leary"
+        },
+        {
+            "name": "Dave Conway-Jones"
+        }
     ],
     "dependencies": {
         "clone": "2.1.2",
-        "i18next": "11.6.0",
+        "i18next": "12.1.0",
         "json-stringify-safe": "5.0.1",
@@ -18,0 +22,0 @@ "jsonata": "1.5.4",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

49725

increased by0.5%

Lines of code

1178

increased by1.29%

Dependency changes

• + Addedi18next@12.1.0(transitive)

• - Removedi18next@11.6.0(transitive)

• Updatedi18next@12.1.0