Class NestSystemLogger

Hierarchy

  • ConsoleLogger
    • NestSystemLogger

Constructors

constructor

Properties

context? inspectOptions options originalContext? lastTimestampAt?

Methods

colorize debug error fatal formatContext formatMessage formatPid formatTimestampDiff getInspectOptions getTimestamp isLevelEnabled log printAsJson printMessages printStackTrace resetContext setContext setLogLevels stringifyMessage stringifyReplacer updateAndGetTimestampDiff verbose warn

Constructors

constructor

  • new NestSystemLogger(): NestSystemLogger

    Returns NestSystemLogger

  • new NestSystemLogger(context: string): NestSystemLogger

    Parameters

    • context: string

    Returns NestSystemLogger

  • new NestSystemLogger(options: ConsoleLoggerOptions): NestSystemLogger

    Parameters

    • options: ConsoleLoggerOptions

    Returns NestSystemLogger

  • new NestSystemLogger(
        context: string,
        options: ConsoleLoggerOptions,
    ): NestSystemLogger

    Parameters

    • context: string
    • options: ConsoleLoggerOptions

    Returns NestSystemLogger

Properties

Protected Optionalcontext

context?: string

The context of the logger (can be set manually or automatically inferred).

ProtectedinspectOptions

inspectOptions: InspectOptions

The options used for the "inspect" method.

Protectedoptions

options: ConsoleLoggerOptions

The options of the logger.

Protected OptionaloriginalContext

originalContext?: string

The original context of the logger (set in the constructor).

Protected Static OptionallastTimestampAt

lastTimestampAt?: number

The last timestamp at which the log message was printed.

Methods

Protectedcolorize

  • colorize(message: string, logLevel: LogLevel): string

    Parameters

    • message: string
    • logLevel: LogLevel

    Returns string

debug

  • debug(message: any, context?: string): void

    Write a 'debug' level log, if the configured level allows for it. Prints to stdout with newline.

    Parameters

    • message: any
    • Optionalcontext: string

    Returns void

  • debug(message: any, ...optionalParams: any[]): void

    Write a 'debug' level log, if the configured level allows for it. Prints to stdout with newline.

    Parameters

    • message: any
    • ...optionalParams: any[]

    Returns void

error

  • error(message: any, stackOrContext?: string): void

    Write an 'error' level log, if the configured level allows for it. Prints to stderr with newline.

    Parameters

    • message: any
    • OptionalstackOrContext: string

    Returns void

  • error(message: any, stack?: string, context?: string): void

    Write an 'error' level log, if the configured level allows for it. Prints to stderr with newline.

    Parameters

    • message: any
    • Optionalstack: string
    • Optionalcontext: string

    Returns void

  • error(message: any, ...optionalParams: any[]): void

    Write an 'error' level log, if the configured level allows for it. Prints to stderr with newline.

    Parameters

    • message: any
    • ...optionalParams: any[]

    Returns void

fatal

  • fatal(message: any, context?: string): void

    Write a 'fatal' level log, if the configured level allows for it. Prints to stdout with newline.

    Parameters

    • message: any
    • Optionalcontext: string

    Returns void

  • fatal(message: any, ...optionalParams: any[]): void

    Write a 'fatal' level log, if the configured level allows for it. Prints to stdout with newline.

    Parameters

    • message: any
    • ...optionalParams: any[]

    Returns void

ProtectedformatContext

  • formatContext(context: string): string

    Parameters

    • context: string

    Returns string

ProtectedformatMessage

  • formatMessage(
        logLevel: LogLevel,
        message: unknown,
        pidMessage: string,
        formattedLogLevel: string,
        contextMessage: string,
        timestampDiff: string,
    ): string

    Parameters

    • logLevel: LogLevel
    • message: unknown
    • pidMessage: string
    • formattedLogLevel: string
    • contextMessage: string
    • timestampDiff: string

    Returns string

ProtectedformatPid

  • formatPid(pid: number): string

    Parameters

    • pid: number

    Returns string

ProtectedformatTimestampDiff

  • formatTimestampDiff(timestampDiff: number): string

    Parameters

    • timestampDiff: number

    Returns string

ProtectedgetInspectOptions

  • getInspectOptions(): InspectOptions

    Returns InspectOptions

ProtectedgetTimestamp

  • getTimestamp(): string

    Returns string

isLevelEnabled

  • isLevelEnabled(level: LogLevel): boolean

    Parameters

    • level: LogLevel

    Returns boolean

log

  • log(message: any, context?: string): void

    Write a 'log' level log, if the configured level allows for it. Prints to stdout with newline.

    Parameters

    • message: any
    • Optionalcontext: string

    Returns void

  • log(message: any, ...optionalParams: any[]): void

    Write a 'log' level log, if the configured level allows for it. Prints to stdout with newline.

    Parameters

    • message: any
    • ...optionalParams: any[]

    Returns void

ProtectedprintAsJson

  • printAsJson(
        message: unknown,
        options: {
            context: string;
            errorStack?: unknown;
            logLevel: LogLevel;
            writeStreamType?: "stdout" | "stderr";
        },
    ): void

    Parameters

    • message: unknown
    • options: {
          context: string;
          errorStack?: unknown;
          logLevel: LogLevel;
          writeStreamType?: "stdout" | "stderr";
      }

    Returns void

ProtectedprintMessages

  • printMessages(messages: unknown[], context?: string, logLevel?: LogLevel): void

    Parameters

    • messages: unknown[]
    • Optionalcontext: string
    • OptionallogLevel: LogLevel

    Returns void

ProtectedprintStackTrace

  • printStackTrace(stack: string): void

    Parameters

    • stack: string

    Returns void

resetContext

  • resetContext(): void

    Resets the logger context to the value that was passed in the constructor.

    Returns void

setContext

  • setContext(context: string): void

    Set logger context

    Parameters

    • context: string

      context

    Returns void

setLogLevels

  • setLogLevels(levels: LogLevel[]): void

    Set log levels

    Parameters

    • levels: LogLevel[]

      log levels

    Returns void

ProtectedstringifyMessage

  • stringifyMessage(message: unknown): string

    Parameters

    • message: unknown

    Returns string

ProtectedstringifyReplacer

  • stringifyReplacer(key: string, value: unknown): unknown

    Parameters

    • key: string
    • value: unknown

    Returns unknown

ProtectedupdateAndGetTimestampDiff

  • updateAndGetTimestampDiff(): string

    Returns string

verbose

  • verbose(message: any, context?: string): void

    Write a 'verbose' level log, if the configured level allows for it. Prints to stdout with newline.

    Parameters

    • message: any
    • Optionalcontext: string

    Returns void

  • verbose(message: any, ...optionalParams: any[]): void

    Write a 'verbose' level log, if the configured level allows for it. Prints to stdout with newline.

    Parameters

    • message: any
    • ...optionalParams: any[]

    Returns void

warn

  • warn(message: any, context?: string): void

    Write a 'warn' level log, if the configured level allows for it. Prints to stdout with newline.

    Parameters

    • message: any
    • Optionalcontext: string

    Returns void

  • warn(message: any, ...optionalParams: any[]): void

    Write a 'warn' level log, if the configured level allows for it. Prints to stdout with newline.

    Parameters

    • message: any
    • ...optionalParams: any[]

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods