Skip to content

Commit

Permalink
improve jsdocs for Logger
Browse files Browse the repository at this point in the history
  • Loading branch information
mceachen committed Mar 28, 2022
1 parent 4381a24 commit b56c6bc
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions src/Logger.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,14 @@ const _debuglog = util.debuglog("batch-cluster")
const noop = () => undefined

/**
* Default `Logger` implementation. `debug` and `info` go to
* util.debuglog("batch-cluster")`. `warn` and `error` go to `console.warn` and
* `console.error`.
* Default `Logger` implementation.
*
* - `debug` and `info` go to {@link util.debuglog}("batch-cluster")`.
*
* - `warn` and `error` go to `console.warn` and `console.error`.
*
* @see https://nodejs.org/api/util.html#util_util_debuglog_section
* @see https://nodejs.org/api/console.html
*/
export const ConsoleLogger: Logger = Object.freeze({
/**
Expand Down

0 comments on commit b56c6bc

Please sign in to comment.