mirror of
https://github.com/node-red/node-red.git
synced 2025-03-01 10:36:34 +00:00
Get jdsoc tagging right for util module
This commit is contained in:
52
packages/node_modules/@node-red/util/lib/log.js
generated
vendored
52
packages/node_modules/@node-red/util/lib/log.js
generated
vendored
@@ -15,6 +15,11 @@
|
||||
* @ignore
|
||||
**/
|
||||
|
||||
/**
|
||||
* @module log
|
||||
* @memberof module:@node-red/util
|
||||
*/
|
||||
|
||||
var util = require("util");
|
||||
var EventEmitter = require("events").EventEmitter;
|
||||
|
||||
@@ -87,7 +92,9 @@ var consoleLogger = function(msg) {
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
var log = module.exports = {
|
||||
|
||||
FATAL: 10,
|
||||
ERROR: 20,
|
||||
WARN: 30,
|
||||
@@ -119,40 +126,79 @@ var log = module.exports = {
|
||||
log.addHandler(new LogHandler());
|
||||
}
|
||||
},
|
||||
|
||||
/**
|
||||
* Add a log handler function.
|
||||
*/
|
||||
addHandler: function(func) {
|
||||
logHandlers.push(func);
|
||||
},
|
||||
|
||||
/**
|
||||
* Remove a log handler function.
|
||||
*/
|
||||
removeHandler: function(func) {
|
||||
var index = logHandlers.indexOf(func);
|
||||
if (index > -1) {
|
||||
logHandlers.splice(index,1);
|
||||
}
|
||||
},
|
||||
|
||||
/**
|
||||
* Log a message object.
|
||||
*/
|
||||
log: function(msg) {
|
||||
msg.timestamp = Date.now();
|
||||
logHandlers.forEach(function(handler) {
|
||||
handler.emit("log",msg);
|
||||
});
|
||||
},
|
||||
|
||||
/**
|
||||
* Log a message at INFO level.
|
||||
*/
|
||||
info: function(msg) {
|
||||
log.log({level:log.INFO,msg:msg});
|
||||
},
|
||||
|
||||
/**
|
||||
* Log a message at WARN level.
|
||||
*/
|
||||
warn: function(msg) {
|
||||
log.log({level:log.WARN,msg:msg});
|
||||
},
|
||||
|
||||
/**
|
||||
* Log a message at ERROR level.
|
||||
*/
|
||||
error: function(msg) {
|
||||
log.log({level:log.ERROR,msg:msg});
|
||||
},
|
||||
|
||||
/**
|
||||
* Log a message at TRACE level.
|
||||
*/
|
||||
trace: function(msg) {
|
||||
log.log({level:log.TRACE,msg:msg});
|
||||
},
|
||||
|
||||
/**
|
||||
* Log a message at DEBUG level.
|
||||
*/
|
||||
debug: function(msg) {
|
||||
log.log({level:log.DEBUG,msg:msg});
|
||||
},
|
||||
|
||||
/**
|
||||
* Log a metric event.
|
||||
*/
|
||||
metric: function() {
|
||||
return metricsEnabled;
|
||||
},
|
||||
|
||||
/**
|
||||
* Log an audit event.
|
||||
*/
|
||||
audit: function(msg,req) {
|
||||
msg.level = log.AUDIT;
|
||||
if (req) {
|
||||
@@ -164,4 +210,10 @@ var log = module.exports = {
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Perform a message catalog lookup.
|
||||
* @name _
|
||||
* @function
|
||||
* @memberof module:@node-red/util.module:log
|
||||
*/
|
||||
log["_"] = i18n._;
|
||||
|
Reference in New Issue
Block a user