Class LogEventTransport

Route controller for events.

When a logger referencing this transport (via getLogger(tag)) produces an event, the event will be verified against the transport's filter; if the event is deemed valid, it will be passed on to all assigned consumers, as well as any listeners registered to the transport's event emitter.

Hierarchy

Implements

Constructors

Properties

events: EventEmitter<LogEventLike> = ...
forwardRef: ((ev: LogEventLike) => void) = ...

Alternate of interceptEvent that can be passed by value without losing the this context of the interceptor.

Type declaration

test: LogEventFilterPredicate = LogEventGuard.FILTER_ACCEPT_ALL

Predicate that will be used for log event validation.

FILTER_ACCEPT_ALL: LogEventFilterPredicate = ...
FILTER_BLOCK_ALL: LogEventFilterPredicate = ...

Methods

  • Requests a new event instance from this interceptor.

    For the sake of consistency between loggers, it should be left up to the interceptor to generate event instances.

    Parameters

    • level: number
    • tag: string
    • message: string
    • Optional params: any[]
    • Optional timestamp: number

    Returns LogEventLike

  • Convenience for setting enabled state based on a flag.

    Mutually exclusive operation to setCustomFilter; if a custom filter was set before calling this, it will be cleared.

    Returns

    this for operation chaining.

    Parameters

    • enabled: boolean

      the filter state to use, e.g. true to accept all events, or false to reject all events.

    Returns LogEventTransport

Generated using TypeDoc