frodovdr/node-red
1
0
Fork 0
mirror of https://github.com/node-red/node-red.git synced 2025-03-01 10:36:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

API documentation updates

Browse Source
This commit is contained in:
Nick O'Leary
2018-12-05 13:00:25 +00:00
parent ee47646cf7
commit 8e1c15419c
7 changed files with 124 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
packages/node_modules/@node-red/util/lib/log.js vendored
View File

@@ -16,8 +16,8 @@
**/
/**
* @module log
* @memberof module:@node-red/util
* Logging utilities
* @mixin @node-red/util_log
*/
var util = require("util");
@@ -128,14 +128,16 @@ var log = module.exports = {
},
/**
* Add a log handler function.
* Add a log handler function
* @memberof @node-red/util_log
*/
addHandler: function(func) {
logHandlers.push(func);
},
/**
* Remove a log handler function.
* Remove a log handler function
* @memberof @node-red/util_log
*/
removeHandler: function(func) {
var index = logHandlers.indexOf(func);
@@ -145,7 +147,8 @@ var log = module.exports = {
},
/**
* Log a message object.
* Log a message object
* @memberof @node-red/util_log
*/
log: function(msg) {
msg.timestamp = Date.now();
@@ -155,42 +158,48 @@ var log = module.exports = {
},
/**
* Log a message at INFO level.
* Log a message at INFO level
* @memberof @node-red/util_log
*/
info: function(msg) {
log.log({level:log.INFO,msg:msg});
},
/**
* Log a message at WARN level.
* Log a message at WARN level
* @memberof @node-red/util_log
*/
warn: function(msg) {
log.log({level:log.WARN,msg:msg});
},
/**
* Log a message at ERROR level.
* Log a message at ERROR level
* @memberof @node-red/util_log
*/
error: function(msg) {
log.log({level:log.ERROR,msg:msg});
},
/**
* Log a message at TRACE level.
* Log a message at TRACE level
* @memberof @node-red/util_log
*/
trace: function(msg) {
log.log({level:log.TRACE,msg:msg});
},
/**
* Log a message at DEBUG level.
* Log a message at DEBUG level
* @memberof @node-red/util_log
*/
debug: function(msg) {
log.log({level:log.DEBUG,msg:msg});
},
/**
* Log a metric event.
* Check if metrics are enabled
* @memberof @node-red/util_log
*/
metric: function() {
return metricsEnabled;
@@ -198,6 +207,7 @@ var log = module.exports = {
/**
* Log an audit event.
* @memberof @node-red/util_log
*/
audit: function(msg,req) {
msg.level = log.AUDIT;
@@ -214,6 +224,6 @@ var log = module.exports = {
* Perform a message catalog lookup.
* @name _
* @function
* @memberof module:@node-red/util.module:log
* @memberof @node-red/util_log
*/
log["_"] = i18n._;