Class Logger

constructor

• new Logger(
      opts?: {
          formatter?: { call: Function };
          level?: number;
          pipe?:
              | { write: (line: string) => void }
              | ((line: string, severity: number) => void);
          progname?: string;
      },
  ): Logger

  Parameters

  • Optionalopts: {
        formatter?: { call: Function };
        level?: number;
        pipe?:
            | { write: (line: string) => void }
            | ((line: string, severity: number) => void);
        progname?: string;
    }

    • Optionalformatter?: { call: Function }

    • Optionallevel?: number

    • Optionalpipe?: { write: (line: string) => void } | ((line: string, severity: number) => void)

      Destination for formatted output lines, mirroring Ruby's Logger.new(logdev). Accepts anything with a write(line) method (e.g. a Node stream), or a plain function called as (line, severity) — the numeric severity lets a function-style pipe route by level (e.g. console.error for ERROR+, console.warn for WARN) without overriding add(). Defaults to process.stderr/console.error when omitted.

    • Optionalprogname?: string

  Returns Logger

level

progname

formatter

• get formatter(): { call: Function }

  getter/setter so custom logger impls can access this.formatter

  Returns { call: Function }

• set formatter(f: { call: Function }): void

  Parameters

  • f: { call: Function }

  Returns void

maxSeverity

• get maxSeverity(): number

  Returns number

  The highest severity level logged so far.

add

• add(
      severity: string | number,
      message?: string | { inspect?(): string },
      progname?: string | Function,
  ): boolean

  Log a message at the given severity level.

  Parameters

  • severity: string | number

    Severity level (numeric constant or string name).

  • Optionalmessage: string | { inspect?(): string }

    The message to log.

  • Optionalprogname: string | Function

    Program name or message supplier function.

  Returns boolean

debug

• debug(
      msg?: string | { inspect?(): string },
      progname?: string | Function,
  ): boolean

  Parameters

  • Optionalmsg: string | { inspect?(): string }
  • Optionalprogname: string | Function

  Returns boolean

error

• error(
      msg?: string | { inspect?(): string },
      progname?: string | Function,
  ): boolean

  Parameters

  • Optionalmsg: string | { inspect?(): string }
  • Optionalprogname: string | Function

  Returns boolean

fatal

• fatal(
      msg?: string | { inspect?(): string },
      progname?: string | Function,
  ): boolean

  Parameters

  • Optionalmsg: string | { inspect?(): string }
  • Optionalprogname: string | Function

  Returns boolean

getFormatter

• getFormatter(): { call: Function }

  Returns { call: Function }

getLevel

• getLevel(): number

  Returns number

getMaxSeverity

• getMaxSeverity(): number

  Returns number

getProgramName

• getProgramName(): string

  Returns string

info

• info(
      msg?: string | { inspect?(): string },
      progname?: string | Function,
  ): boolean

  Parameters

  • Optionalmsg: string | { inspect?(): string }
  • Optionalprogname: string | Function

  Returns boolean

isDebug

• isDebug(): boolean

  Returns boolean

isDebugEnabled

• isDebugEnabled(): boolean

  Returns boolean

  Whether DEBUG-level messages will be logged.

isErrorEnabled

• isErrorEnabled(): boolean

  Returns boolean

  Whether ERROR-level messages will be logged.

isFatalEnabled

• isFatalEnabled(): boolean

  Returns boolean

  Whether FATAL-level messages will be logged.

isInfo

• isInfo(): boolean

  Returns boolean

isInfoEnabled

• isInfoEnabled(): boolean

  Returns boolean

  Whether INFO-level messages will be logged.

isWarnEnabled

• isWarnEnabled(): boolean

  Returns boolean

  Whether WARN-level messages will be logged.

log

• log(
      severity: string | number,
      message?: string | { inspect?(): string },
      progname?: string | Function,
  ): boolean

  Alias for add (Ruby Logger API).

  Parameters

  • severity: string | number
  • Optionalmessage: string | { inspect?(): string }
  • Optionalprogname: string | Function

  Returns boolean

setFormatter

• setFormatter(f: any): void

  Parameters

  • f: any

  Returns void

setLevel

• setLevel(n: any): void

  Parameters

  • n: any

  Returns void

setProgramName

• setProgramName(n: any): void

  Parameters

  • n: any

  Returns void

unknown

• unknown(
      msg?: string | { inspect?(): string },
      progname?: string | Function,
  ): boolean

  Parameters

  • Optionalmsg: string | { inspect?(): string }
  • Optionalprogname: string | Function

  Returns boolean

warn

• warn(
      msg?: string | { inspect?(): string },
      progname?: string | Function,
  ): boolean

  Parameters

  • Optionalmsg: string | { inspect?(): string }
  • Optionalprogname: string | Function

  Returns boolean