Class Logger

A logger.

Index

Constructors

Methods

debug error getLevel getName info isEnabled isLevelEnabled log setLevel warn warnOnce getGlobalLevel getLogger setGlobalLevel

Constructors

constructor

new Logger(name, level?, logFn?): Logger
Constructs a new logger.
Parameters
- name: string
  Logger name
- Optional level: LogLevel
  Logger level. Defaults to the global log level
- Optional logFn: ((...data) => void)
  Logger function. Defaults to console.log
  - - (...data): void
    - Parameters
      Rest ...data: unknown[]
      Returns void
Returns Logger
- Defined in src/framework/util/log/logger.ts:58

Methods

debug

debug(...data): void
Log data with debug level.
Parameters
- Rest ...data: unknown[]
  Data to log.
Returns void
- Defined in src/framework/util/log/logger.ts:117

error

error(...data): void
Log data with error level.
Parameters
- Rest ...data: unknown[]
  Data to log.
Returns void
- Defined in src/framework/util/log/logger.ts:153

getLevel

getLevel(): LogLevel
Gets the logger's level.

Returns LogLevel
- Defined in src/framework/util/log/logger.ts:74

getName

getName(): string
Gets the logger's name.

Returns string
- Defined in src/framework/util/log/logger.ts:67

info

info(...data): void
Log data with information level.
Parameters
- Rest ...data: unknown[]
  Data to log.
Returns void
- Defined in src/framework/util/log/logger.ts:125

isEnabled

isEnabled(): boolean
Checks whether this logger is enabled.

Returns boolean
- Defined in src/framework/util/log/logger.ts:93

isLevelEnabled

isLevelEnabled(levelOrLabel): boolean
Checks whether this logger is enabled for the given the log level.
Parameters
- levelOrLabel: string | LogLevel
  The log level or level label.
Returns boolean
- Defined in src/framework/util/log/logger.ts:101

log

log(...data): void
Log data with level given by getLevel.
Parameters
- Rest ...data: unknown[]
  Data to log
Returns void
- Defined in src/framework/util/log/logger.ts:161
log(level, ...data): void
Log data with given level.
Parameters
- level: LogLevel
  Log level
- Rest ...data: unknown[]
  Data to log
Returns void
- Defined in src/framework/util/log/logger.ts:167

setLevel

setLevel(level): void
Sets the logger's level.
Parameters
- level: undefined | null | string | LogLevel
  the new level or level label or null, or undefined.
Returns void
- Defined in src/framework/util/log/logger.ts:82

warn

warn(...data): void
Log data with warning level.
Parameters
- Rest ...data: unknown[]
  Data to log.
Returns void
- Defined in src/framework/util/log/logger.ts:133

warnOnce

warnOnce(...data): void
Log data once with warning level.
Parameters
- Rest ...data: unknown[]
  Data to log.
Returns void
- Defined in src/framework/util/log/logger.ts:141

`Static` getGlobalLevel

getGlobalLevel(): LogLevel
Gets the global log level applicable to all loggers.

Returns LogLevel
- Defined in src/framework/util/log/logger.ts:37

`Static` getLogger

getLogger(name?): Logger
Parameters
- Optional name: string
Returns Logger
- Defined in src/framework/util/log/logger.ts:24

`Static` setGlobalLevel

setGlobalLevel(level): LogLevel
Sets the global log level applicable to all loggers.
Parameters
- level: string | LogLevel
  The new global log level or level label
Returns LogLevel
The previous global level
- Defined in src/framework/util/log/logger.ts:46

Generated using TypeDoc