multi-level-logger

# Writing Logs

# Logging Functions

  • Logging functions write to console.log(), except for calls to Err and Fatal which write to console.error()
  • data accepts a string, or any object that converts with JSON.stringify()
    • data also will accept a function - without parameters - that will be evaluated only if the log level will be written, and returns a string or object
  • options overrides the OutputFormatting() settings for individual calls to a logging function

# Log(data, options)

Log()

Always write to the log no matter the configured log level

# Dev(data, options)

# Trace(data, options)

# Debug(data, options)

# Info(data, options)

# Warn(data, options)

# Err(data, options)

# Fatal(data, options)

Parameter Required Type Notes
data yes tLogObject Data to write to the log
options yes ILogOptions Additional options for controlling log output

TIP

The configured log level will write any messages at or above that level.

# Log Data Type

# tLogObject

  • Union type
  • string | unknown | (() => string | unknown)

# Interfaces for Log Writing

# ILogOptions

Parameter Required Type Notes
asIs no boolean Override the conversion of a Javascript Object via JSON
  • - When passing in an object for the data property
configuration no ILogOptionConfiguration Override formatting configuration
logName no string When multiple named logs are configured, write to this named log
noFunctionEval no boolean Don't evaluate a function when passed in as data
  • - When true, writes the function code to the log output instead of the evaluated result
  • - Useful for debugging

# ILogOptionConfiguration

Log writting configuration for the single message

Parameter Required Type Notes
includeCodeLocation no boolean Show the code location when printing to the log
includeTimestamp no boolean Show a timestamp when printing to the log
jsonFormatter no number Amount of whitespace to include for the JSON.stringify() function
useColors no boolean Display colors in a terminal capable of showing them

← Usage Examples →