Class NestLogger

Hierarchy

  • Logger
    • NestLogger

Implements

  • ILogger

Constructors

constructor

Properties

context? localInstanceRef? options logBuffer logLevels? staticInstanceRef?

Accessors

localInstance

Methods

debug error fatal info log verbose warn attachBuffer debug detachBuffer error fatal flush getTimestamp isLevelEnabled log overrideLogger verbose warn

Constructors

constructor

  • new NestLogger(): NestLogger

  • Returns NestLogger

  • new NestLogger(context): NestLogger

  • Parameters

    • context: string

    Returns NestLogger

  • new NestLogger(context, options?): NestLogger

  • Parameters

    • context: string
    • Optional options: {
          timestamp?: boolean;
      }
      • Optional timestamp?: boolean

    Returns NestLogger

Properties

Protected Optional context

context?: string

Protected Optional localInstanceRef

localInstanceRef?: LoggerService

Protected options

options: {
    timestamp?: boolean;
}

Type declaration

  • Optional timestamp?: boolean

Static Protected logBuffer

logBuffer: LogBufferRecord[]

Static Protected Optional logLevels

logLevels?: ("verbose" | "debug" | "log" | "warn" | "error" | "fatal")[]

Static Protected Optional staticInstanceRef

staticInstanceRef?: LoggerService

Accessors

localInstance

  • get localInstance(): LoggerService

  • Returns LoggerService

Methods

debug

  • debug(message, context?): void

  • Write a 'debug' level log.

    Parameters

    • message: any
    • Optional context: string

    Returns void

  • debug(message, ...optionalParams): void

  • Parameters

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

    Returns void

error

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

  • Write an 'error' level log.

    Parameters

    • message: any
    • Optional stack: string
    • Optional context: string

    Returns void

  • error(message, ...optionalParams): void

  • Parameters

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

    Returns void

fatal

  • fatal(message, context?): void

  • Write a 'fatal' level log.

    Parameters

    • message: any
    • Optional context: string

    Returns void

  • fatal(message, ...optionalParams): void

  • Parameters

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

    Returns void

info

log

  • log(message, context?): void

  • Write a 'log' level log.

    Parameters

    • message: any
    • Optional context: string

    Returns void

  • log(message, ...optionalParams): void

  • Parameters

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

    Returns void

verbose

  • verbose(message, context?): void

  • Write a 'verbose' level log.

    Parameters

    • message: any
    • Optional context: string

    Returns void

  • verbose(message, ...optionalParams): void

  • Parameters

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

    Returns void

warn

  • warn(message, context?): void

  • Write a 'warn' level log.

    Parameters

    • message: any
    • Optional context: string

    Returns void

  • warn(message, ...optionalParams): void

  • Parameters

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

    Returns void

Static attachBuffer

  • attachBuffer(): void

  • Attach buffer. Turns on initialization logs buffering.

    Returns void

Static debug

  • debug(message, context?): void

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

    Parameters

    • message: any
    • Optional context: string

    Returns void

  • debug(message, ...optionalParams): void

  • Parameters

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

    Returns void

Static detachBuffer

  • detachBuffer(): void

  • Detach buffer. Turns off initialization logs buffering.

    Returns void

Static error

  • error(message, stackOrContext?): void

  • Write an 'error' level log.

    Parameters

    • message: any
    • Optional stackOrContext: string

    Returns void

  • error(message, context?): void

  • Parameters

    • message: any
    • Optional context: string

    Returns void

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

  • Parameters

    • message: any
    • Optional stack: string
    • Optional context: string

    Returns void

  • error(message, ...optionalParams): void

  • Parameters

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

    Returns void

Static fatal

  • fatal(message, context?): void

  • Write a 'fatal' level log.

    Parameters

    • message: any
    • Optional context: string

    Returns void

  • fatal(message, ...optionalParams): void

  • Parameters

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

    Returns void

Static flush

  • flush(): void

  • Print buffered logs and detach buffer.

    Returns void

Static getTimestamp

  • getTimestamp(): string

  • Returns string

Static isLevelEnabled

  • isLevelEnabled(level): boolean

  • Parameters

    • level: "verbose" | "debug" | "log" | "warn" | "error" | "fatal"

    Returns boolean

Static log

  • log(message, context?): void

  • Write a 'log' level log.

    Parameters

    • message: any
    • Optional context: string

    Returns void

  • log(message, ...optionalParams): void

  • Parameters

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

    Returns void

Static overrideLogger

  • overrideLogger(logger): any

  • Parameters

    • logger: boolean | LoggerService | ("verbose" | "debug" | "log" | "warn" | "error" | "fatal")[]

    Returns any

Static verbose

  • verbose(message, context?): void

  • Write a 'verbose' level log.

    Parameters

    • message: any
    • Optional context: string

    Returns void

  • verbose(message, ...optionalParams): void

  • Parameters

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

    Returns void

Static warn

  • warn(message, context?): void

  • Write a 'warn' level log.

    Parameters

    • message: any
    • Optional context: string

    Returns void

  • warn(message, ...optionalParams): void

  • Parameters

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

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcontextlocalInstanceRefoptionslogBufferlogLevelsstaticInstanceReflocalInstancedebugerrorfatalinfologverbosewarnattachBufferdebugdetachBuffererrorfatalflushgetTimestampisLevelEnabledlogoverrideLoggerverbosewarn