Class Logger

Hierarchy

EventEmitter<
 {
 debug: [data: string];
 entry: [data: string, level: LogLevel];
 error: [data: string | Error];
 info: [data: string];
 notice: [data: string];
 send: [data: IOMessage];
 warn: [data: string | Error];
 },
>
- Logger

Index

Constructors

constructor

new Logger(options?: Partial<LoggerOptions>): Logger
Parameters
- options: Partial<LoggerOptions> = {}
Returns Logger
Overrides EventEmitter<{ entry: [data: string, level: LogLevel]; send: [data: IOMessage]; error: [data: string | Error]; warn: [data: string | Error]; notice: [data: string]; info: [data: string]; debug: [data: string]; }>.constructor
- Defined in src/logger.ts:100

Properties

`Protected`_entries

_entries: string[] = []

`Protected` `Readonly`io

io: Set<IO<SupportedInterface>> = ...

`Protected`options

options: Partial<LoggerOptions> = {}

`Static`prefixed

prefixed: string | boolean

Accessors

attachedIO

get attachedIO(): number
Get the number of attached streams

Returns number
number of attached streams
- Defined in src/logger.ts:120

entries

get entries(): string[]
Gets the array of log entries. Empty if retainLogs is false.

Returns string[]
A copy of the log entries array.
- Defined in src/logger.ts:112

Methods

addListener

addListener<
 T extends
 "error"
 | "info"
 | "warn"
 | "notice"
 | "debug"
 | "send"
 | "entry",
>(
 event: T,
 fn: (
 ...args: ArgumentMap<
 {
 debug: [data: string];
 entry: [data: string, level: LogLevel];
 error: [data: string | Error];
 info: [data: string];
 notice: [data: string];
 send: [data: IOMessage];
 warn: [data: string | Error];
 },
 >[Extract<
 T,
 "error"
 | "info"
 | "warn"
 | "notice"
 | "debug"
 | "send"
 | "entry",
 >],
 ) => void,
 context?: any,
): this
Type Parameters
- T extends "error" | "info" | "warn" | "notice" | "debug" | "send" | "entry"
Parameters
- event: T
- fn: (
 ...args: ArgumentMap<
 {
 debug: [data: string];
 entry: [data: string, level: LogLevel];
 error: [data: string | Error];
 info: [data: string];
 notice: [data: string];
 send: [data: IOMessage];
 warn: [data: string | Error];
 },
 >[Extract<
 T,
 "error"
 | "info"
 | "warn"
 | "notice"
 | "debug"
 | "send"
 | "entry",
 >],
 ) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.addListener
- Defined in node_modules/eventemitter3/index.d.ts:45

attach

attach(io: Logger, opt: IOAttachOptions): void
Attaches an input or output to the Logger
Parameters
- io: Logger
  The interface to attach.
- opt: IOAttachOptions
  Options for the I/O If log levels are not provided, all log levels will be attached.
Returns void
- Defined in src/logger.ts:130
attach(io: I, opt?: IOAttachOptions): void
Attaches an input or output to the Logger
Type Parameters
- I extends SupportedInterface
Parameters
- io: I
 The interface to attach.
- Optionalopt: IOAttachOptions
 Options for the I/O If log levels are not provided, all log levels will be attached.
Returns void
- Defined in src/logger.ts:131
attach(io: IO): void
Attaches an input or output to the Logger
Type Parameters
- I extends SupportedInterface
Parameters
- io: IO
 The interface to attach.
Returns void
- Defined in src/logger.ts:132

clear

clear(): boolean
Clears retained log entries

Returns boolean
whether the entries where cleared or not
- Defined in src/logger.ts:267

clearIO

clearIO(): void
Detaches all I/O

Returns void
- Defined in src/logger.ts:202

debug

debug(...data: string[]): void
Logs a debug message with the LogLevel.DEBUG level.
Parameters
- ...data: string[]
  The log message.
Returns void
- Defined in src/logger.ts:326

detach

detach(io: Logger, opt: IODetachOptions): void
Detaches an input or output from the Logger
Parameters
- io: Logger
  The interface to detach.
  
  If log levels are not provided, all log levels will be detached.
- opt: IODetachOptions
Returns void
- Defined in src/logger.ts:176
detach(io: I, opt?: IODetachOptions): void
Detaches an input or output from the Logger
Type Parameters
- I extends SupportedInterface
Parameters
- io: I
 The interface to detach.
 
 If log levels are not provided, all log levels will be detached.
- Optionalopt: IODetachOptions
Returns void
- Defined in src/logger.ts:177
detach(io: IO): void
Detaches an input or output from the Logger
Type Parameters
- I extends SupportedInterface
Parameters
- io: IO
 The interface to detach.
 
 If log levels are not provided, all log levels will be detached.
Returns void
- Defined in src/logger.ts:178

emit

emit<
 T extends
 "error"
 | "info"
 | "warn"
 | "notice"
 | "debug"
 | "send"
 | "entry",
>(
 event: T,
 ...args: ArgumentMap<
 {
 debug: [data: string];
 entry: [data: string, level: LogLevel];
 error: [data: string | Error];
 info: [data: string];
 notice: [data: string];
 send: [data: IOMessage];
 warn: [data: string | Error];
 },
 >[Extract<
 T,
 "error"
 | "info"
 | "warn"
 | "notice"
 | "debug"
 | "send"
 | "entry",
 >],
): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends "error" | "info" | "warn" | "notice" | "debug" | "send" | "entry"
Parameters
- event: T
- ...args: ArgumentMap<
 {
 debug: [data: string];
 entry: [data: string, level: LogLevel];
 error: [data: string | Error];
 info: [data: string];
 notice: [data: string];
 send: [data: IOMessage];
 warn: [data: string | Error];
 },
 >[Extract<
 T,
 "error"
 | "info"
 | "warn"
 | "notice"
 | "debug"
 | "send"
 | "entry",
 >]
Returns boolean
Inherited from EventEmitter.emit
- Defined in node_modules/eventemitter3/index.d.ts:32

error

error(data: string | Error): Error
Logs an error message with the LogLevel.ERROR level.
Parameters
- data: string | Error
  The error or log message.
Returns Error
Todo
Replace with Error.isError once it is widely available
- Defined in src/logger.ts:314

eventNames

eventNames(): (
    "error"
    | "info"
    | "warn"
    | "notice"
    | "debug"
    | "send"
    | "entry"
)[]
Return an array listing the events for which the emitter has registered listeners.

Returns ("error" | "info" | "warn" | "notice" | "debug" | "send" | "entry")[]
Inherited from EventEmitter.eventNames
- Defined in node_modules/eventemitter3/index.d.ts:15

info

info(...data: string[]): void
Logs a message with the LogLevel.INFO level.
Parameters
- ...data: string[]
  The log message.
Returns void
- Defined in src/logger.ts:282

listenerCount

listenerCount(
event: "error" | "info" | "warn" | "notice" | "debug" | "send" | "entry",
): number
Return the number of listeners listening to a given event.
Parameters
- event: "error" | "info" | "warn" | "notice" | "debug" | "send" | "entry"
Returns number
Inherited from EventEmitter.listenerCount
- Defined in node_modules/eventemitter3/index.d.ts:27

listeners

listeners<
 T extends
 "error"
 | "info"
 | "warn"
 | "notice"
 | "debug"
 | "send"
 | "entry",
>(
 event: T,
): (
 (
 ...args: ArgumentMap<
 {
 debug: [data: string];
 entry: [data: string, level: LogLevel];
 error: [data: string | Error];
 info: [data: string];
 notice: [data: string];
 send: [data: IOMessage];
 warn: [data: string | Error];
 },
 >[Extract<
 T,
 "error"
 | "info"
 | "warn"
 | "notice"
 | "debug"
 | "send"
 | "entry",
 >],
 ) => void
)[]
Return the listeners registered for a given event.
Type Parameters
- T extends "error" | "info" | "warn" | "notice" | "debug" | "send" | "entry"
Parameters
- event: T
Returns (
 (
 ...args: ArgumentMap<
 {
 debug: [data: string];
 entry: [data: string, level: LogLevel];
 error: [data: string | Error];
 info: [data: string];
 notice: [data: string];
 send: [data: IOMessage];
 warn: [data: string | Error];
 },
 >[Extract<
 T,
 "error"
 | "info"
 | "warn"
 | "notice"
 | "debug"
 | "send"
 | "entry",
 >],
 ) => void
)[]
Inherited from EventEmitter.listeners
- Defined in node_modules/eventemitter3/index.d.ts:20

notice

notice(...data: string[]): void
Logs a info message with the LogLevel.NOTICE level.
Parameters
- ...data: string[]
  The log message.
Returns void
- Defined in src/logger.ts:291

off

off<T extends "error" | "info" | "warn" | "notice" | "debug" | "send" | "entry">(
 event: T,
 fn?: (
 ...args: ArgumentMap<
 {
 debug: [data: string];
 entry: [data: string, level: LogLevel];
 error: [data: string | Error];
 info: [data: string];
 notice: [data: string];
 send: [data: IOMessage];
 warn: [data: string | Error];
 },
 >[Extract<
 T,
 "error"
 | "info"
 | "warn"
 | "notice"
 | "debug"
 | "send"
 | "entry",
 >],
 ) => void,
 context?: any,
 once?: boolean,
): this
Type Parameters
- T extends "error" | "info" | "warn" | "notice" | "debug" | "send" | "entry"
Parameters
- event: T
- Optionalfn: (
 ...args: ArgumentMap<
 {
 debug: [data: string];
 entry: [data: string, level: LogLevel];
 error: [data: string | Error];
 info: [data: string];
 notice: [data: string];
 send: [data: IOMessage];
 warn: [data: string | Error];
 },
 >[Extract<
 T,
 "error"
 | "info"
 | "warn"
 | "notice"
 | "debug"
 | "send"
 | "entry",
 >],
 ) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from EventEmitter.off
- Defined in node_modules/eventemitter3/index.d.ts:69

on

on<T extends "error" | "info" | "warn" | "notice" | "debug" | "send" | "entry">(
 event: T,
 fn: (
 ...args: ArgumentMap<
 {
 debug: [data: string];
 entry: [data: string, level: LogLevel];
 error: [data: string | Error];
 info: [data: string];
 notice: [data: string];
 send: [data: IOMessage];
 warn: [data: string | Error];
 },
 >[Extract<
 T,
 "error"
 | "info"
 | "warn"
 | "notice"
 | "debug"
 | "send"
 | "entry",
 >],
 ) => void,
 context?: any,
): this
Add a listener for a given event.
Type Parameters
- T extends "error" | "info" | "warn" | "notice" | "debug" | "send" | "entry"
Parameters
- event: T
- fn: (
 ...args: ArgumentMap<
 {
 debug: [data: string];
 entry: [data: string, level: LogLevel];
 error: [data: string | Error];
 info: [data: string];
 notice: [data: string];
 send: [data: IOMessage];
 warn: [data: string | Error];
 },
 >[Extract<
 T,
 "error"
 | "info"
 | "warn"
 | "notice"
 | "debug"
 | "send"
 | "entry",
 >],
 ) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.on
- Defined in node_modules/eventemitter3/index.d.ts:40

once

once<
 T extends
 "error"
 | "info"
 | "warn"
 | "notice"
 | "debug"
 | "send"
 | "entry",
>(
 event: T,
 fn: (
 ...args: ArgumentMap<
 {
 debug: [data: string];
 entry: [data: string, level: LogLevel];
 error: [data: string | Error];
 info: [data: string];
 notice: [data: string];
 send: [data: IOMessage];
 warn: [data: string | Error];
 },
 >[Extract<
 T,
 "error"
 | "info"
 | "warn"
 | "notice"
 | "debug"
 | "send"
 | "entry",
 >],
 ) => void,
 context?: any,
): this
Add a one-time listener for a given event.
Type Parameters
- T extends "error" | "info" | "warn" | "notice" | "debug" | "send" | "entry"
Parameters
- event: T
- fn: (
 ...args: ArgumentMap<
 {
 debug: [data: string];
 entry: [data: string, level: LogLevel];
 error: [data: string | Error];
 info: [data: string];
 notice: [data: string];
 send: [data: IOMessage];
 warn: [data: string | Error];
 },
 >[Extract<
 T,
 "error"
 | "info"
 | "warn"
 | "notice"
 | "debug"
 | "send"
 | "entry",
 >],
 ) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.once
- Defined in node_modules/eventemitter3/index.d.ts:54

removeAllListeners

removeAllListeners(
    event?:
        | "error"
        | "info"
        | "warn"
        | "notice"
        | "debug"
        | "send"
        | "entry",
): this
Remove all listeners, or those of the specified event.
Parameters
- Optionalevent: "error" | "info" | "warn" | "notice" | "debug" | "send" | "entry"
Returns this
Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<
 T extends
 "error"
 | "info"
 | "warn"
 | "notice"
 | "debug"
 | "send"
 | "entry",
>(
 event: T,
 fn?: (
 ...args: ArgumentMap<
 {
 debug: [data: string];
 entry: [data: string, level: LogLevel];
 error: [data: string | Error];
 info: [data: string];
 notice: [data: string];
 send: [data: IOMessage];
 warn: [data: string | Error];
 },
 >[Extract<
 T,
 "error"
 | "info"
 | "warn"
 | "notice"
 | "debug"
 | "send"
 | "entry",
 >],
 ) => void,
 context?: any,
 once?: boolean,
): this
Remove the listeners of a given event.
Type Parameters
- T extends "error" | "info" | "warn" | "notice" | "debug" | "send" | "entry"
Parameters
- event: T
- Optionalfn: (
 ...args: ArgumentMap<
 {
 debug: [data: string];
 entry: [data: string, level: LogLevel];
 error: [data: string | Error];
 info: [data: string];
 notice: [data: string];
 send: [data: IOMessage];
 warn: [data: string | Error];
 },
 >[Extract<
 T,
 "error"
 | "info"
 | "warn"
 | "notice"
 | "debug"
 | "send"
 | "entry",
 >],
 ) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from EventEmitter.removeListener
- Defined in node_modules/eventemitter3/index.d.ts:63

send

send(contents: string, level: LogLevel): void
Outputs a log message to attached outputs.
Parameters
- contents: string
  The log message to be sent.
- level: LogLevel
  The log level for the message. Defaults to LogLevel.LOG.
Returns void
- Defined in src/logger.ts:212
send(message: IOMessage): void
Outputs a log message to attached outputs.
Parameters
- message: IOMessage
  The message
Returns void
- Defined in src/logger.ts:218

toString

toString(): string
Converts the log entries to a string.

Returns string
A string representation of the log entries.
- Defined in src/logger.ts:259

warn

warn(data: string | Error): Error
Logs a warning message with the LogLevel.WARN level.
Parameters
- data: string | Error
  The error or log message.
Returns Error
Todo
Replace with Error.isError once it is widely available
- Defined in src/logger.ts:301

Class Logger

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Logger

Properties

Protected_entries

Protected Readonlyio

Protectedoptions

Staticprefixed

Accessors

attachedIO

Returns number

entries

Returns string[]

Methods

addListener

Type Parameters

Parameters

Returns this

attach

Parameters

Returns void

Type Parameters

Parameters

Returns void

Type Parameters

Parameters

Returns void

clear

Returns boolean

clearIO

Returns void

debug

Parameters

Returns void

detach

Parameters

Returns void

Type Parameters

Parameters

Returns void

Type Parameters

Parameters

Returns void

emit

Type Parameters

Parameters

Returns boolean

error

Parameters

Returns Error

Todo

eventNames

Returns ("error" | "info" | "warn" | "notice" | "debug" | "send" | "entry")[]

info

Parameters

Returns void

listenerCount

Parameters

Returns number

listeners

Type Parameters

Parameters

notice

Parameters

Returns void

off

Type Parameters

Parameters

Returns this

on

Type Parameters

Parameters

`Protected`_entries

`Protected` `Readonly`io

`Protected`options

`Static`prefixed