Class Logger

Index

Constructors

constructor

Methods

alert clear critical debug emerg error flush fork info log notice warning

Constructors

constructor

new Logger(
    printers: ILoggerPrinter[],
    options?: LoggerOptions,
    parent?: null | Logger,
): Logger
Create a new logger.
Parameters
- printers: ILoggerPrinter[]
  The printer(s) to use for logging
- Optionaloptions: LoggerOptions
  Options for the logger
- parent: null | Logger = null
  An optional parent logger to inherit settings from (used when forking a new logger)
Returns Logger
- Defined in logger/logger.ts:78

Methods

alert

alert(
    error: unknown,
    description?: string,
    metadata?: LoggerMetadataWithoutError,
): Promise<void>
Log an alert error with an optional description and metadata.
Parameters
- error: unknown
  The error to log
- Optionaldescription: string
  An optional description to prefix the error message
- Optionalmetadata: LoggerMetadataWithoutError
  Optional metadata to attach to the log message
Returns Promise<void>
- Defined in logger/logger.ts:146

clear

clear(): Promise<void>
Clear the console.

Returns Promise<void>
- Defined in logger/logger.ts:106

critical

critical(
    error: unknown,
    description?: string,
    metadata?: LoggerMetadataWithoutError,
): Promise<void>
Log a critical error with an optional description and metadata.
Parameters
- error: unknown
  The error to log
- Optionaldescription: string
  An optional description to prefix the error message
- Optionalmetadata: LoggerMetadataWithoutError
  Optional metadata to attach to the log message
Returns Promise<void>
- Defined in logger/logger.ts:168

debug

debug(metadata: LoggerMetadata, description: string): Promise<void>
Log debug metadata with a description.

If process.env.DEBUG is truthy, a stack trace will be captured and attached to the log message.
Parameters
- metadata: LoggerMetadata
  Metadata to log
- description: string
  Description of the debug log
Returns Promise<void>
- Defined in logger/logger.ts:256

emerg

emerg(
    error: unknown,
    description?: string,
    metadata?: LoggerMetadataWithoutError,
): Promise<void>
Log an emergency error with an optional description and metadata.
Parameters
- error: unknown
  The error to log
- Optionaldescription: string
  An optional description to prefix the error message
- Optionalmetadata: LoggerMetadataWithoutError
  Optional metadata to attach to the log message
Returns Promise<void>
- Defined in logger/logger.ts:124

error

error(
    error: unknown,
    description?: string,
    metadata?: LoggerMetadataWithoutError,
): Promise<void>
Log an error with an optional description and metadata.
Parameters
- error: unknown
  The error to log
- Optionaldescription: string
  An optional description to prefix the error message
- Optionalmetadata: LoggerMetadataWithoutError
  Optional metadata to attach to the log message
Returns Promise<void>
- Defined in logger/logger.ts:190

flush

flush(): Promise<void>
Flush any buffered output.

Returns Promise<void>
- Defined in logger/logger.ts:113

fork

fork(options?: LoggerOptions): Logger
Create a new logger that inherits settings from this logger.
Parameters
- Optionaloptions: LoggerOptions
  Options for the new logger
Returns Logger
A new logger that inherits settings from this logger
- Defined in logger/logger.ts:99

info

info(message: string, metadata?: LoggerMetadata): Promise<void>
Log an informative message with optional metadata.
Parameters
- message: string
  The message to log
- Optionalmetadata: LoggerMetadata
  Optional metadata to attach to the log message
Returns Promise<void>
- Defined in logger/logger.ts:243

log

log(
    level: LoggerLogLevel,
    message: string,
    options?: LoggerLogOptions,
): Promise<void>
Log a message with a specific log level, message and options.
Parameters
- level: LoggerLogLevel
  Log level
- message: string
  Message
- Optionaloptions: LoggerLogOptions
  Optional log options
Returns Promise<void>
- Defined in logger/logger.ts:274

notice

notice(message: string, metadata?: LoggerMetadata): Promise<void>
Log a notice message with optional metadata.
Parameters
- message: string
  The message to log
- Optionalmetadata: LoggerMetadata
  Optional metadata to attach to the log message
Returns Promise<void>
- Defined in logger/logger.ts:233

warning

warning(
    error: unknown,
    description?: string,
    metadata?: LoggerMetadataWithoutError,
): Promise<void>
Log a warning with an optional description and metadata.
Parameters
- error: unknown
  The warning to log
- Optionaldescription: string
  An optional description to prefix the warning message
- Optionalmetadata: LoggerMetadataWithoutError
  Optional metadata to attach to the log message
Returns Promise<void>
- Defined in logger/logger.ts:212

Class Logger

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Logger

Methods

alert

Parameters

Returns Promise<void>

clear

Returns Promise<void>

critical

Parameters

Returns Promise<void>

debug

Parameters

Returns Promise<void>

emerg

Parameters

Returns Promise<void>

error

Parameters

Returns Promise<void>

flush

Returns Promise<void>

fork

Parameters

Returns Logger

info

Parameters

Returns Promise<void>

log

Parameters

Returns Promise<void>

notice

Parameters

Returns Promise<void>

warning

Parameters

Returns Promise<void>

Settings

On This Page