Class Logger<TSinks>

Type Parameters

TSinks extends SinkMap = Record<never, never>

Hierarchy

TypedEventEmitter<LoggerEvent>
- Logger

Constructors

constructor

new Logger<TSinks extends SinkMap = Record<never, never>>(
options?: LoggerOptions,
): Logger<TSinks>
Creates a new Logger instance with the specified options.
Type Parameters
- TSinks extends SinkMap = Record<never, never>
Parameters
- options: LoggerOptions = {}
  Configuration options for the logger
Returns Logger<TSinks>
Overrides TypedEventEmitter<LoggerEvent>.constructor
- Defined in packages/logger/src/logger.ts:148

Methods

`Optional`[captureRejectionSymbol]

"[captureRejectionSymbol]"?(
    error: Error,
    event: string | symbol,
    ...args: any[],
): void
The Symbol.for('nodejs.rejection') method is called in case a promise rejection happens when emitting an event and captureRejections is enabled on the emitter. It is possible to use events.captureRejectionSymbol in place of Symbol.for('nodejs.rejection').
```
import { EventEmitter, captureRejectionSymbol } from 'node:events';

class MyClass extends EventEmitter {
  constructor() {
    super({ captureRejections: true });
  }

  [captureRejectionSymbol](err, event, ...args) {
    console.log('rejection happened for', event, 'with', err, ...args);
    this.destroy(err);
  }

  destroy(err) {
    // Tear the resource down here.
  }
}
```
Parameters
- error: Error
- event: string | symbol
- ...args: any[]
Returns void
Since
v13.4.0, v12.16.0
Inherited from TypedEventEmitter.[captureRejectionSymbol]
- Defined in node_modules/.bun/@types+node@25.6.0/node_modules/@types/node/events.d.ts:87

addListener

addListener<KEvent extends keyof LoggerEvent>(
event: KEvent,
listener: (...args: LoggerEvent[KEvent]) => void,
): this
Registers an event listener for the specified event (alias for on).
Type Parameters
- KEvent extends keyof LoggerEvent
  The type of event to listen for.
Parameters
- event: KEvent
  The event name to listen for.
- listener: (...args: LoggerEvent[KEvent]) => void
  The callback function that handles the event.
Returns this
This instance for chaining.
Example
```
class MyEmitter extends TypedEventEmitter<{ baz: [boolean] }> {}
const emitter = new MyEmitter();
emitter.addListener('baz', payload => {
  console.log(payload); // payload is boolean
});
```
Inherited from TypedEventEmitter.addListener
- Defined in packages/common/dist/typed-event-emitter.d.ts:86

close

close(): Promise<void>
Closes the logger, flushes pending logs, and releases resources.

Returns Promise<void>
- Defined in packages/logger/src/logger.ts:287

debug

debug<SNames extends (keyof TSinks)[] = (keyof TSinks)[]>(
object: SinkBodiesIntersection<TSinks, SNames[number]>,
sinkNames?: SNames,
): void
Logs a message at the DEBUG level to the specified sinks.
Type Parameters
- SNames extends (keyof TSinks)[] = (keyof TSinks)[]
Parameters
- object: SinkBodiesIntersection<TSinks, SNames[number]>
  The log message object
- sinkNames: SNames = ...
  Optional array of sink names to log to; logs to all sinks if omitted
Returns void
- Defined in packages/logger/src/logger.ts:254

emit

emit<KEvent extends keyof LoggerEvent>(
event: KEvent,
...args: LoggerEvent[KEvent],
): boolean
Emits an event with the specified payload.
Type Parameters
- KEvent extends keyof LoggerEvent
  The type of event to emit.
Parameters
- event: KEvent
  The event name to emit.
- ...args: LoggerEvent[KEvent]
  The data to send with the event.
Returns boolean
Whether the event had listeners.
Example
```
class MyEmitter extends TypedEventEmitter<{ foo: [string] }> {}
const emitter = new MyEmitter();
emitter.emit('foo', 'hello');
```
Inherited from TypedEventEmitter.emit
- Defined in packages/common/dist/typed-event-emitter.d.ts:26

error

error<SNames extends (keyof TSinks)[] = (keyof TSinks)[]>(
object: SinkBodiesIntersection<TSinks, SNames[number]>,
sinkNames?: SNames,
): void
Logs a message at the ERROR level to the specified sinks.
Type Parameters
- SNames extends (keyof TSinks)[] = (keyof TSinks)[]
Parameters
- object: SinkBodiesIntersection<TSinks, SNames[number]>
  The log message object
- sinkNames: SNames = ...
  Optional array of sink names to log to; logs to all sinks if omitted
Returns void
- Defined in packages/logger/src/logger.ts:215

eventNames

eventNames(): (string | symbol)[]
Returns an array listing the events for which the emitter has registered listeners.
```
import { EventEmitter } from 'node:events';

const myEE = new EventEmitter();
myEE.on('foo', () => {});
myEE.on('bar', () => {});

const sym = Symbol('symbol');
myEE.on(sym, () => {});

console.log(myEE.eventNames());
// Prints: [ 'foo', 'bar', Symbol(symbol) ]
```
Returns (string | symbol)[]
Since
v6.0.0
Inherited from TypedEventEmitter.eventNames
- Defined in node_modules/.bun/@types+node@25.6.0/node_modules/@types/node/events.d.ts:154

flush

flush(): Promise<void>
Flushes all pending logs and the sinks' buffers, and waits for completion.

Returns Promise<void>
- Defined in packages/logger/src/logger.ts:277

getMaxListeners

getMaxListeners(): number
Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to events.defaultMaxListeners.

Returns number
Since
v1.0.0
Inherited from TypedEventEmitter.getMaxListeners
- Defined in node_modules/.bun/@types+node@25.6.0/node_modules/@types/node/events.d.ts:161

info

info<SNames extends (keyof TSinks)[] = (keyof TSinks)[]>(
object: SinkBodiesIntersection<TSinks, SNames[number]>,
sinkNames?: SNames,
): void
Logs a message at the INFO level to the specified sinks.
Type Parameters
- SNames extends (keyof TSinks)[] = (keyof TSinks)[]
Parameters
- object: SinkBodiesIntersection<TSinks, SNames[number]>
  The log message object
- sinkNames: SNames = ...
  Optional array of sink names to log to; logs to all sinks if omitted
Returns void
- Defined in packages/logger/src/logger.ts:241

listenerCount

listenerCount<KEvent extends keyof LoggerEvent>(event: KEvent): number
Returns the number of listeners for the specified event.
Type Parameters
- KEvent extends keyof LoggerEvent
  The type of event.
Parameters
- event: KEvent
  The event name.
Returns number
The number of listeners.
Example
```
class MyEmitter extends TypedEventEmitter<{ foo: [string] }> {}
const emitter = new MyEmitter();
emitter.on('foo', () => {});
const count = emitter.listenerCount('foo');
```
Inherited from TypedEventEmitter.listenerCount
- Defined in packages/common/dist/typed-event-emitter.d.ts:144

listeners

listeners<KEvent extends keyof LoggerEvent>(
event: KEvent,
): ((...args: LoggerEvent[KEvent]) => void)[]
Returns a copy of the array of listeners for the specified event.
Type Parameters
- KEvent extends keyof LoggerEvent
  The type of event.
Parameters
- event: KEvent
  The event name.
Returns ((...args: LoggerEvent[KEvent]) => void)[]
An array of listener functions.
Example
```
class MyEmitter extends TypedEventEmitter<{ foo: [string] }> {}
const emitter = new MyEmitter();
emitter.on('foo', () => {});
const listeners = emitter.listeners('foo');
```
Inherited from TypedEventEmitter.listeners
- Defined in packages/common/dist/typed-event-emitter.d.ts:162

log

log<SNames extends (keyof TSinks)[] = (keyof TSinks)[]>(
object: SinkBodiesIntersection<TSinks, SNames[number]>,
sinkNames?: SNames,
): void
Logs a message at the TRACE level to the specified sinks.
Type Parameters
- SNames extends (keyof TSinks)[] = (keyof TSinks)[]
Parameters
- object: SinkBodiesIntersection<TSinks, SNames[number]>
  The log message object
- sinkNames: SNames = ...
  Optional array of sink names to log to; logs to all sinks if omitted
Returns void
- Defined in packages/logger/src/logger.ts:267

off

off<KEvent extends keyof LoggerEvent>(
event: KEvent,
listener: (...args: LoggerEvent[KEvent]) => void,
): this
Removes an event listener for the specified event (alias for removeListener).
Type Parameters
- KEvent extends keyof LoggerEvent
  The type of event.
Parameters
- event: KEvent
  The event name.
- listener: (...args: LoggerEvent[KEvent]) => void
  The callback function to remove.
Returns this
This instance for chaining.
Example
```
class MyEmitter extends TypedEventEmitter<{ foo: [string] }> {}
const emitter = new MyEmitter();
const handler = (payload: string) => {};
emitter.on('foo', handler);
emitter.off('foo', handler);
```
Inherited from TypedEventEmitter.off
- Defined in packages/common/dist/typed-event-emitter.d.ts:126

on

on<KEvent extends keyof LoggerEvent>(
event: KEvent,
listener: (...args: LoggerEvent[KEvent]) => void,
): this
Registers an event listener for the specified event.
Type Parameters
- KEvent extends keyof LoggerEvent
  The type of event to listen for.
Parameters
- event: KEvent
  The event name to listen for.
- listener: (...args: LoggerEvent[KEvent]) => void
  The callback function that handles the event.
Returns this
This instance for chaining.
Example
```
class MyEmitter extends TypedEventEmitter<{ foo: [string] }> {}
const emitter = new MyEmitter();
emitter.on('foo', payload => {
  console.log(payload); // payload is string
});
```
Inherited from TypedEventEmitter.on
- Defined in packages/common/dist/typed-event-emitter.d.ts:46

once

once<KEvent extends keyof LoggerEvent>(
event: KEvent,
listener: (...args: LoggerEvent[KEvent]) => void,
): this
Registers a one-time event listener for the specified event.
Type Parameters
- KEvent extends keyof LoggerEvent
  The type of event to listen for.
Parameters
- event: KEvent
  The event name to listen for.
- listener: (...args: LoggerEvent[KEvent]) => void
  The callback function that handles the event.
Returns this
This instance for chaining.
Example
```
class MyEmitter extends TypedEventEmitter<{ bar: [number] }> {}
const emitter = new MyEmitter();
emitter.once('bar', payload => {
  console.log(payload); // payload is number
});
```
Inherited from TypedEventEmitter.once
- Defined in packages/common/dist/typed-event-emitter.d.ts:66

prependListener

prependListener<KEvent extends keyof LoggerEvent>(
event: KEvent,
listener: (...args: LoggerEvent[KEvent]) => void,
): this
Adds a listener to the beginning of the listeners array for the specified event.
Type Parameters
- KEvent extends keyof LoggerEvent
  The type of event.
Parameters
- event: KEvent
  The event name.
- listener: (...args: LoggerEvent[KEvent]) => void
  The callback function to add.
Returns this
This instance for chaining.
Example
```
class MyEmitter extends TypedEventEmitter<{ foo: [string] }> {}
const emitter = new MyEmitter();
emitter.prependListener('foo', payload => {
  console.log(payload);
});
```
Inherited from TypedEventEmitter.prependListener
- Defined in packages/common/dist/typed-event-emitter.d.ts:200

prependOnceListener

prependOnceListener<KEvent extends keyof LoggerEvent>(
event: KEvent,
listener: (...args: LoggerEvent[KEvent]) => void,
): this
Adds a one-time listener to the beginning of the listeners array for the specified event.
Type Parameters
- KEvent extends keyof LoggerEvent
  The type of event.
Parameters
- event: KEvent
  The event name.
- listener: (...args: LoggerEvent[KEvent]) => void
  The callback function to add.
Returns this
This instance for chaining.
Example
```
class MyEmitter extends TypedEventEmitter<{ foo: [string] }> {}
const emitter = new MyEmitter();
emitter.prependOnceListener('foo', payload => {
  console.log(payload);
});
```
Inherited from TypedEventEmitter.prependOnceListener
- Defined in packages/common/dist/typed-event-emitter.d.ts:220

rawListeners

rawListeners<KEvent extends keyof LoggerEvent>(
event: KEvent,
): ((...args: LoggerEvent[KEvent]) => void)[]
Returns a copy of the array of raw listeners for the specified event.
Type Parameters
- KEvent extends keyof LoggerEvent
  The type of event.
Parameters
- event: KEvent
  The event name.
Returns ((...args: LoggerEvent[KEvent]) => void)[]
An array of raw listener functions.
Example
```
class MyEmitter extends TypedEventEmitter<{ foo: [string] }> {}
const emitter = new MyEmitter();
emitter.on('foo', () => {});
const rawListeners = emitter.rawListeners('foo');
```
Inherited from TypedEventEmitter.rawListeners
- Defined in packages/common/dist/typed-event-emitter.d.ts:180

registerSink

registerSink<
    TSinkName extends string,
    TSink extends LoggerSink<unknown, unknown>,
    TSinkArgs extends unknown[],
>(
    sinkName: TSinkName,
    sinkFactory: (...args: TSinkArgs) => TSink,
    ...sinkArgs: TSinkArgs,
): Logger<TSinks & Record<TSinkName, (...args: TSinkArgs) => TSink>>
Registers a new sink (logging destination) with the logger.

The factory is serialized and re-evaluated inside the worker, so its body must be self-contained (no module-scoped imports captured by closure).
Type Parameters
- TSinkName extends string
- TSink extends LoggerSink<unknown, unknown>
- TSinkArgs extends unknown[]
Parameters
- sinkName: TSinkName
  The name of the sink
- sinkFactory: (...args: TSinkArgs) => TSink
  The factory building the sink
- ...sinkArgs: TSinkArgs
  The factory arguments
Returns Logger<TSinks & Record<TSinkName, (...args: TSinkArgs) => TSink>>
The logger instance with new type (for chaining)
- Defined in packages/logger/src/logger.ts:184

removeAllListeners

removeAllListeners<E extends string | symbol>(eventName?: string | symbol): this
Removes all listeners, or those of the specified eventName.

It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

Returns a reference to the EventEmitter, so that calls can be chained.
Type Parameters
- E extends string | symbol
Parameters
- OptionaleventName: string | symbol
Returns this
Since
v0.1.26
Inherited from TypedEventEmitter.removeAllListeners
- Defined in node_modules/.bun/@types+node@25.6.0/node_modules/@types/node/events.d.ts:338

removeListener

removeListener<KEvent extends keyof LoggerEvent>(
event: KEvent,
listener: (...args: LoggerEvent[KEvent]) => void,
): this
Removes an event listener for the specified event.
Type Parameters
- KEvent extends keyof LoggerEvent
  The type of event.
Parameters
- event: KEvent
  The event name.
- listener: (...args: LoggerEvent[KEvent]) => void
  The callback function to remove.
Returns this
This instance for chaining.
Example
```
class MyEmitter extends TypedEventEmitter<{ foo: [string] }> {}
const emitter = new MyEmitter();
const handler = (payload: string) => {};
emitter.on('foo', handler);
emitter.removeListener('foo', handler);
```
Inherited from TypedEventEmitter.removeListener
- Defined in packages/common/dist/typed-event-emitter.d.ts:106

setMaxListeners

setMaxListeners(n: number): this
By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.

Returns a reference to the EventEmitter, so that calls can be chained.
Parameters
- n: number
Returns this
Since
v0.3.5
Inherited from TypedEventEmitter.setMaxListeners
- Defined in node_modules/.bun/@types+node@25.6.0/node_modules/@types/node/events.d.ts:436

warn

warn<SNames extends (keyof TSinks)[] = (keyof TSinks)[]>(
object: SinkBodiesIntersection<TSinks, SNames[number]>,
sinkNames?: SNames,
): void
Logs a message at the WARN level to the specified sinks.
Type Parameters
- SNames extends (keyof TSinks)[] = (keyof TSinks)[]
Parameters
- object: SinkBodiesIntersection<TSinks, SNames[number]>
  The log message object
- sinkNames: SNames = ...
  Optional array of sink names to log to; logs to all sinks if omitted
Returns void
- Defined in packages/logger/src/logger.ts:228

Class Logger<TSinks>

Type Parameters

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Logger<TSinks>

Methods

Optional[captureRejectionSymbol]

Parameters

Returns void

Since

addListener

Type Parameters

Parameters

Returns this

Example

close

Returns Promise<void>

debug

Type Parameters

Parameters

Returns void

emit

Type Parameters

Parameters

Returns boolean

Example

error

Type Parameters

Parameters

Returns void

eventNames

Returns (string | symbol)[]

Since

flush

Returns Promise<void>

getMaxListeners

Returns number

Since

info

Type Parameters

Parameters

Returns void

listenerCount

Type Parameters

Parameters

Returns number

Example

listeners

Type Parameters

Parameters

Returns ((...args: LoggerEvent[KEvent]) => void)[]

Example

log

Type Parameters

Parameters

Returns void

off

Type Parameters

Parameters

Returns this

Example

on

Type Parameters

Parameters

Returns this

Example

once

Type Parameters

Parameters

Returns this

Example

prependListener

Type Parameters

Parameters

`Optional`[captureRejectionSymbol]