Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
logging-utils
Advanced tools
logging-utils - npm Package Compare versions
Comparing version 3.0.7 to 3.0.8
@@ -38,15 +38,2 @@ 'use strict'; | ||
| /** | ||
| * @typedef {Object} Logging - logging functionality | ||
| * @property {Function} error - an error-level logging function | ||
| * @property {Function} warn - a warn-level logging function | ||
| * @property {Function} info - an info-level logging function | ||
| * @property {Function} debug - an debug-level logging function | ||
| * @property {Function} trace - a trace-level logging function | ||
| * @property {boolean} warnEnabled - whether warn-level logging is enabled or not | ||
| * @property {boolean} infoEnabled - whether info-level logging is enabled or not | ||
| * @property {boolean} debugEnabled - whether debug-level logging is enabled or not | ||
| * @property {boolean} traceEnabled - whether trace-level logging is enabled or not | ||
| */ | ||
| // Exports | ||
@@ -80,41 +67,2 @@ module.exports = { | ||
| /** | ||
| * @typedef {Object} LoggingSettings - The logging settings to use for configuring logging functionality | ||
| * @property {string|undefined} [logLevel] - the level of logging to use ('error', 'warn', 'info', 'debug' or 'trace') | ||
| * @property {boolean|undefined} [useLevelPrefixes] - whether to prepend level prefixes to logged messages or not | ||
| * @property {boolean|undefined} [useConsoleTrace] - whether to use console.trace or console.log for trace level logging | ||
| * @property {Object|undefined} [underlyingLogger] - the optional underlying logger to use to do the actual logging | ||
| * | ||
| * The optional logLevel, if defined and valid, sets the level of logging to be used. If undefined or invalid, the | ||
| * defaultLogLevel will be used instead. | ||
| * | ||
| * Log levels: | ||
| * - error - only logs at error level | ||
| * - warn - only logs at warn & error levels | ||
| * - info - logs at info, warn & error levels | ||
| * - debug - logs at debug, info, warn & error levels | ||
| * - trace - logs at trace, debug, info, warn & error levels | ||
| * | ||
| * The optional useLevelPrefixes, if defined and either true or false, indicates whether or not to prepend log level | ||
| * prefixes to logged messages. | ||
| * | ||
| * The optional underlyingLogger, if defined, determines the underlying logger that will be used to do the actual | ||
| * logging. If defined, the underlyingLogger must have error, warn, info, debug & trace methods; otherwise console will | ||
| * be used as the underlying logger. For AWS Lambdas, only console will be used and the underlyingLogger is only | ||
| * currently used for testing the logging functionality. | ||
| * | ||
| * The optional useConsoleTrace, if defined and either true or false, indicates whether to use console.trace (true) or | ||
| * console.log (false) for trace level logging. However, before setting this to true, be warned that console.trace logs | ||
| * to standard error and ALSO outputs the stack trace, which is generally NOT what you want for the most detailed level | ||
| * of logging. | ||
| */ | ||
| /** | ||
| * @typedef {Object} LoggingOptions - Logging options are a subset of the full (@linkcode LoggingSettings}, which are | ||
| * used to configure ONLY the simple property logging settings (i.e. all except underlyingLogger) | ||
| * @property {string|undefined} [logLevel] - the level of logging to use ('error', 'warn', 'info', 'debug' or 'trace') | ||
| * @property {boolean|undefined} [useLevelPrefixes] - whether to prepend level prefixes to logged messages or not | ||
| * @property {boolean|undefined} [useConsoleTrace] - whether to use console.trace or console.log for trace level logging | ||
| */ | ||
| /** | ||
| * Returns true, if the given target already has logging functionality configured on it; otherwise returns false. | ||
@@ -121,0 +69,0 @@ * @param {Object} target the target object to check |
| { | ||
| "name": "logging-utils", | ||
| "description": "Utilities for configuring simple log level based logging functionality on an object", | ||
| "version": "3.0.7", | ||
| "version": "3.0.8", | ||
| "author": "Byron du Preez", | ||
@@ -6,0 +6,0 @@ "license": "Apache-2.0", |
@@ -1,2 +0,2 @@ | ||
| # logging-utils v3.0.7 | ||
| # logging-utils v3.0.8 | ||
| Utilities for configuring simple log level based logging functionality on an object. | ||
@@ -166,2 +166,5 @@ | ||
| ### 3.0.8 | ||
| - Moved all typedefs from `logging.js` module to new `type-defs.js` module | ||
| ### 3.0.7 | ||
@@ -168,0 +171,0 @@ - Added `Logging` typedef |
| { | ||
| "name": "logging-utils-tests", | ||
| "description": "Unit tests for logging-utils", | ||
| "version": "3.0.7", | ||
| "version": "3.0.8", | ||
| "author": "Byron du Preez", | ||
@@ -6,0 +6,0 @@ "license": "Apache-2.0", |
New alerts
License Policy Violation
LicenseThis 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
LicenseThis 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
- increased by0.12%
81188
- Number of package files
- increased by12.5%
9
- Lines of code
- increased by0.09%
1158
- Number of lines in readme file
- increased by1.19%
255
No dependency changes