Interface Logger

The interface for a basic logger implementation.

interface Logger {
    logLevel: LogLevel;
    hasAnyListeners(): boolean;
    hasListeners(type: "log"): boolean;
    log(target: LogTarget, level: LogLevel, ...messages: readonly any[]): void;
    on<K extends "log">(
        type: K,
        handler: EventHandler<LogEventMap[K]>,
        options?: SignalOptions,
    ): Unsubscribe;
}

Hierarchy (View Summary)

ReadonlyEventHost<LogEventMap>
- Logger

Implemented by

LoggerImpl

Index

Properties

Methods

hasAnyListeners hasListeners log on

Properties

logLevel

logLevel: LogLevel

Methods

hasAnyListeners

hasAnyListeners(): boolean
Returns true if the event host has any listeners.

Returns boolean
Inherited from ReadonlyEventHost.hasAnyListeners
- Defined in event/EventHost.ts:44

hasListeners

hasListeners(type: "log"): boolean
Returns true if the event host has any listeners for the given type.
Parameters
- type: "log"
Returns boolean
Inherited from ReadonlyEventHost.hasListeners
- Defined in event/EventHost.ts:49

log

log(target: LogTarget, level: LogLevel, ...messages: readonly any[]): void
Parameters
- target: LogTarget
- level: LogLevel
- ...messages: readonly any[]
Returns void
- Defined in logging/Logger.ts:37

on

on<K extends "log">(
    type: K,
    handler: EventHandler<LogEventMap[K]>,
    options?: SignalOptions,
): Unsubscribe
Adds an event handler for the given typed event.
Type Parameters
- K extends "log"
Parameters
- type: K
  The key representing the event type to listen for.
- handler: EventHandler<LogEventMap[K]>
  A callback to invoke when the event with the given type is dispatched.
- Optionaloptions: SignalOptions
  Options for changing listening behavior.
Returns Unsubscribe
Returns a method, when invoked, removes the handler.
Inherited from ReadonlyEventHost.on
- Defined in event/EventHost.ts:35