Class Logger

Hierarchy

Logger

Index

Constructors

Methods

addStream createPinnedLine debug error fatal info isPinnedLineBound log releasePinnedLine removeOutput updatePinnedLines warn

Constructors

constructor

new Logger(options?: LoggerOptions): Logger
Parameters
- options: LoggerOptions = {}
Returns Logger
- Defined in logger.ts:119

Methods

addStream

addStream(stream: LoggerStream<Logger | Pick<WritableStream, "write">>): Logger
Adds a new output stream to the logger. If the exact same stream is already added, it will be ignored.
Parameters
- stream: LoggerStream<Logger | Pick<WritableStream, "write">>
Returns Logger
- Defined in logger.ts:156

createPinnedLine

createPinnedLine(level: string, initialMessage?: string): PinnedLine
Creates a pinned line, which will always be at the bottom of the screen.

Due to their nature, they cannot be logged to non-TTY streams.

Pinned lines only work in top-level loggers, because loggers are not an implementation of a TTY stream.
Parameters
- level: string
- Optional initialMessage: string
Returns PinnedLine
- Defined in logger.ts:302

debug

debug(...data: unknown[]): void
Logs a message with log level LoggerLevel.DEBUG
Parameters
- Rest ...data: unknown[]
Returns void
- Defined in logger.ts:173

error

error(...data: unknown[]): void
Logs a message with log level LoggerLevel.ERROR
Parameters
- Rest ...data: unknown[]
Returns void
- Defined in logger.ts:194

fatal

fatal(...data: unknown[]): void
Logs a message with log level LoggerLevel.FATAL
Parameters
- Rest ...data: unknown[]
Returns void
- Defined in logger.ts:201

info

info(...data: unknown[]): void
Logs a message with log level LoggerLevel.INFO
Parameters
- Rest ...data: unknown[]
Returns void
- Defined in logger.ts:180

isPinnedLineBound

isPinnedLineBound(line: PinnedLine): boolean
Parameters
- line: PinnedLine
Returns boolean
- Defined in logger.ts:340

log

log(level: string, ...data: unknown[]): void
Logs a message with the given log level
Parameters
- level: string
- Rest ...data: unknown[]
Returns void
- Defined in logger.ts:208

releasePinnedLine

releasePinnedLine(line: PinnedLine, logLine?: boolean): boolean
Releases a pinned line, causing it to be deleted. If you'd like to log it when removing it, use the logLine parameter.

Returns
If the line was not bound, and there was nothing to remove, the function returns false. Otherwise it returns true.
Parameters
- line: PinnedLine
- logLine: boolean = false
Returns boolean
- Defined in logger.ts:317

removeOutput

removeOutput(outputStream: Logger | Pick<WritableStream, "write">): Logger
Removes a stream (note: the actual stream instead of the object) from the logger.
Parameters
- outputStream: Logger | Pick<WritableStream, "write">
Returns Logger
- Defined in logger.ts:165

updatePinnedLines

updatePinnedLines(): void
Forces an update for all pinned lines.

Returns void
- Defined in logger.ts:331

warn

warn(...data: unknown[]): void
Logs a message with log level LoggerLevel.WARN
Parameters
- Rest ...data: unknown[]
Returns void
- Defined in logger.ts:187

Generated using TypeDoc