Class NestSystemLogger

Hierarchy

ConsoleLogger
- NestSystemLogger

Constructors

constructor

new NestSystemLogger(): NestSystemLogger
Returns NestSystemLogger
Inherited from ConsoleLogger.constructor
- Defined in node_modules/@nestjs/common/services/console-logger.service.d.ts:105
new NestSystemLogger(context: string): NestSystemLogger
Parameters
- context: string
Returns NestSystemLogger
Inherited from ConsoleLogger.constructor
- Defined in node_modules/@nestjs/common/services/console-logger.service.d.ts:106
new NestSystemLogger(options: ConsoleLoggerOptions): NestSystemLogger
Parameters
- options: ConsoleLoggerOptions
Returns NestSystemLogger
Inherited from ConsoleLogger.constructor
- Defined in node_modules/@nestjs/common/services/console-logger.service.d.ts:107
new NestSystemLogger(
context: string,
options: ConsoleLoggerOptions,
): NestSystemLogger
Parameters
- context: string
- options: ConsoleLoggerOptions
Returns NestSystemLogger
Inherited from ConsoleLogger.constructor
- Defined in node_modules/@nestjs/common/services/console-logger.service.d.ts:108

Properties

`Protected` `Optional`context

context?: string

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

`Protected`inspectOptions

inspectOptions: InspectOptions

The options used for the "inspect" method.

`Protected`options

options: ConsoleLoggerOptions

The options of the logger.

`Protected` `Optional`originalContext

originalContext?: string

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

`Protected` `Static` `Optional`lastTimestampAt

lastTimestampAt?: number

The last timestamp at which the log message was printed.

Methods

`Protected`colorize

colorize(
message: string,
logLevel: "verbose" | "debug" | "error" | "warn" | "log" | "fatal",
): string
Parameters
- message: string
- logLevel: "verbose" | "debug" | "error" | "warn" | "log" | "fatal"
Returns string
Inherited from ConsoleLogger.colorize
- Defined in node_modules/@nestjs/common/services/console-logger.service.d.ts:173

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
Inherited from ConsoleLogger.debug
- Defined in node_modules/@nestjs/common/services/console-logger.service.d.ts:132
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
Inherited from ConsoleLogger.debug
- Defined in node_modules/@nestjs/common/services/console-logger.service.d.ts:133

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
Inherited from ConsoleLogger.error
- Defined in node_modules/@nestjs/common/services/console-logger.service.d.ts:119
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
Inherited from ConsoleLogger.error
- Defined in node_modules/@nestjs/common/services/console-logger.service.d.ts:120
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
Inherited from ConsoleLogger.error
- Defined in node_modules/@nestjs/common/services/console-logger.service.d.ts:121

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
Inherited from ConsoleLogger.fatal
- Defined in node_modules/@nestjs/common/services/console-logger.service.d.ts:144
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
Inherited from ConsoleLogger.fatal
- Defined in node_modules/@nestjs/common/services/console-logger.service.d.ts:145

`Protected`formatContext

formatContext(context: string): string
Parameters
- context: string
Returns string
Inherited from ConsoleLogger.formatContext
- Defined in node_modules/@nestjs/common/services/console-logger.service.d.ts:170

`Protected`formatMessage

formatMessage(
    logLevel: "verbose" | "debug" | "error" | "warn" | "log" | "fatal",
    message: unknown,
    pidMessage: string,
    formattedLogLevel: string,
    contextMessage: string,
    timestampDiff: string,
): string
Parameters
- logLevel: "verbose" | "debug" | "error" | "warn" | "log" | "fatal"
- message: unknown
- pidMessage: string
- formattedLogLevel: string
- contextMessage: string
- timestampDiff: string
Returns string
Inherited from ConsoleLogger.formatMessage
- Defined in node_modules/@nestjs/common/services/console-logger.service.d.ts:171

`Protected`formatPid

formatPid(pid: number): string
Parameters
- pid: number
Returns string
Inherited from ConsoleLogger.formatPid
- Defined in node_modules/@nestjs/common/services/console-logger.service.d.ts:169

`Protected`formatTimestampDiff

formatTimestampDiff(timestampDiff: number): string
Parameters
- timestampDiff: number
Returns string
Inherited from ConsoleLogger.formatTimestampDiff
- Defined in node_modules/@nestjs/common/services/console-logger.service.d.ts:176

`Protected`getInspectOptions

getInspectOptions(): InspectOptions
Returns InspectOptions
Inherited from ConsoleLogger.getInspectOptions
- Defined in node_modules/@nestjs/common/services/console-logger.service.d.ts:177

`Protected`getTimestamp

getTimestamp(): string
Returns string
Inherited from ConsoleLogger.getTimestamp
- Defined in node_modules/@nestjs/common/services/console-logger.service.d.ts:161

isLevelEnabled

isLevelEnabled(
level: "verbose" | "debug" | "error" | "warn" | "log" | "fatal",
): boolean
Parameters
- level: "verbose" | "debug" | "error" | "warn" | "log" | "fatal"
Returns boolean
Inherited from ConsoleLogger.isLevelEnabled
- Defined in node_modules/@nestjs/common/services/console-logger.service.d.ts:160

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
Inherited from ConsoleLogger.log
- Defined in node_modules/@nestjs/common/services/console-logger.service.d.ts:113
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
Inherited from ConsoleLogger.log
- Defined in node_modules/@nestjs/common/services/console-logger.service.d.ts:114

`Protected`printAsJson

printAsJson(
    message: unknown,
    options: {
        context: string;
        errorStack?: unknown;
        logLevel: "verbose" | "debug" | "error" | "warn" | "log" | "fatal";
        writeStreamType?: "stdout" | "stderr";
    },
): void
Parameters
- message: unknown
- options: {
      context: string;
      errorStack?: unknown;
      logLevel: "verbose" | "debug" | "error" | "warn" | "log" | "fatal";
      writeStreamType?: "stdout" | "stderr";
  }
Returns void
Inherited from ConsoleLogger.printAsJson
- Defined in node_modules/@nestjs/common/services/console-logger.service.d.ts:163

`Protected`printMessages

printMessages(
    messages: unknown[],
    context?: string,
    logLevel?: "verbose" | "debug" | "error" | "warn" | "log" | "fatal",
): void
Parameters
- messages: unknown[]
- Optionalcontext: string
- OptionallogLevel: "verbose" | "debug" | "error" | "warn" | "log" | "fatal"
Returns void
Overrides ConsoleLogger.printMessages
- Defined in libs/core/src/logger/classes/nest-system-logger.ts:16

`Protected`printStackTrace

printStackTrace(stack: string): void
Parameters
- stack: string
Returns void
Inherited from ConsoleLogger.printStackTrace
- Defined in node_modules/@nestjs/common/services/console-logger.service.d.ts:174

resetContext

resetContext(): void
Resets the logger context to the value that was passed in the constructor.

Returns void
Inherited from ConsoleLogger.resetContext
- Defined in node_modules/@nestjs/common/services/console-logger.service.d.ts:159

setContext

setContext(context: string): void
Set logger context
Parameters
- context: string
  context
Returns void
Inherited from ConsoleLogger.setContext
- Defined in node_modules/@nestjs/common/services/console-logger.service.d.ts:155

setLogLevels

setLogLevels(
levels: ("verbose" | "debug" | "error" | "warn" | "log" | "fatal")[],
): void
Set log levels
Parameters
- levels: ("verbose" | "debug" | "error" | "warn" | "log" | "fatal")[]
  log levels
Returns void
Inherited from ConsoleLogger.setLogLevels
- Defined in node_modules/@nestjs/common/services/console-logger.service.d.ts:150

`Protected`stringifyMessage

stringifyMessage(message: unknown): string
Parameters
- message: unknown
Returns string
Overrides ConsoleLogger.stringifyMessage
- Defined in libs/core/src/logger/classes/nest-system-logger.ts:24

`Protected`stringifyReplacer

stringifyReplacer(key: string, value: unknown): unknown
Parameters
- key: string
- value: unknown
Returns unknown
Inherited from ConsoleLogger.stringifyReplacer
- Defined in node_modules/@nestjs/common/services/console-logger.service.d.ts:178

`Protected`updateAndGetTimestampDiff

updateAndGetTimestampDiff(): string
Returns string
Inherited from ConsoleLogger.updateAndGetTimestampDiff
- Defined in node_modules/@nestjs/common/services/console-logger.service.d.ts:175

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
Inherited from ConsoleLogger.verbose
- Defined in node_modules/@nestjs/common/services/console-logger.service.d.ts:138
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
Inherited from ConsoleLogger.verbose
- Defined in node_modules/@nestjs/common/services/console-logger.service.d.ts:139

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
Inherited from ConsoleLogger.warn
- Defined in node_modules/@nestjs/common/services/console-logger.service.d.ts:126
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
Inherited from ConsoleLogger.warn
- Defined in node_modules/@nestjs/common/services/console-logger.service.d.ts:127

Class NestSystemLogger

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns NestSystemLogger

Parameters

Returns NestSystemLogger

Parameters

Returns NestSystemLogger

Parameters

Returns NestSystemLogger

Properties

Protected Optionalcontext

ProtectedinspectOptions

Protectedoptions

Protected OptionaloriginalContext

Protected Static OptionallastTimestampAt

Methods

Protectedcolorize

Parameters

Returns string

debug

Parameters

Returns void

Parameters

Returns void

error

Parameters

Returns void

Parameters

Returns void

Parameters

Returns void

fatal

Parameters

Returns void

Parameters

Returns void

ProtectedformatContext

Parameters

Returns string

ProtectedformatMessage

Parameters

Returns string

ProtectedformatPid

Parameters

Returns string

ProtectedformatTimestampDiff

Parameters

Returns string

ProtectedgetInspectOptions

Returns InspectOptions

ProtectedgetTimestamp

Returns string

isLevelEnabled

Parameters

Returns boolean

log

Parameters

Returns void

Parameters

Returns void

ProtectedprintAsJson

Parameters

Returns void

ProtectedprintMessages

Parameters

Returns void

ProtectedprintStackTrace

Parameters

Returns void

resetContext

Returns void

setContext

Parameters

Returns void

`Protected` `Optional`context

`Protected`inspectOptions

`Protected`options

`Protected` `Optional`originalContext

`Protected` `Static` `Optional`lastTimestampAt

`Protected`colorize

`Protected`formatContext

`Protected`formatMessage

`Protected`formatPid

`Protected`formatTimestampDiff

`Protected`getInspectOptions

`Protected`getTimestamp

`Protected`printAsJson

`Protected`printMessages

`Protected`printStackTrace

`Protected`stringifyMessage

`Protected`stringifyReplacer

`Protected`updateAndGetTimestampDiff