API reference / @jsprismarine/logger / Logger
Class: Logger
Defined in: logger.ts:61
Helper class for general logging.
Constructors
Constructor
new Logger(
level?,transports?):Logger
Defined in: logger.ts:74
Create a new logger instance
Parameters
level?
"error" | "warn" | "info" | "verbose" | "debug" | "silly" = 'info'
The log level to use.
transports?
LogTransport[] = []
Transports to write to besides the console.
Returns
Logger
The logger instance.
Other
debug()
debug(...
message):void
Defined in: logger.ts:272
Log debug messages.
Parameters
message
...string[]
The message to log.
Returns
void
disable()
disable():
Promise<void>
Defined in: logger.ts:91
On disable hook.
Returns
Promise<void>
enable()
enable():
Promise<void>
Defined in: logger.ts:83
On enable hook.
Returns
Promise<void>
error()
error(
message):void
Defined in: logger.ts:237
Log error messages.
Parameters
message
any
The message to log.
Returns
void
info()
info(...
message):void
Defined in: logger.ts:215
Log information messages.
Parameters
message
...string[]
The message to log.
Returns
void
isEnabled()
isEnabled(
level):boolean
Defined in: logger.ts:128
Check whether a message at level would be written.
Call this before formatting expensive messages so suppressed log lines do not allocate strings or argument arrays on hot paths.
Parameters
level
"error" | "warn" | "info" | "verbose" | "debug" | "silly"
The level the message would use.
Returns
boolean
true when the logger is open and the level is enabled.
onLine()
onLine(
listener):void
Defined in: logger.ts:103
Listen for log messages.
Parameters
listener
(line) => void
The listener to call when a log message is received.
Returns
void
setConsole()
setConsole(
console?):void
Defined in: logger.ts:111
Set the console instance to use.
Parameters
console?
The console instance to use.
Returns
void
silly()
silly(...
message):void
Defined in: logger.ts:283
Log silly messages.
Parameters
message
...string[]
The message to log.
Returns
void
verbose()
verbose(...
message):void
Defined in: logger.ts:261
Log verbose messages.
Parameters
message
...string[]
The message to log.
Returns
void
warn()
warn(...
message):void
Defined in: logger.ts:226
Log warning messages.
Parameters
message
...string[]
The message to log.
Returns
void