Class LoggerTransport

Core mechanism that allows many Logger instances to report back to a shared resource.

Primary entrypoints:

events() - the shared EventEmitter of this tranport
setFilter(...) - determines which events get emitted
setDefaultBroadcastEnabled(...) - toggles global console variable usage

NOTE: Call disableEventCaching() to revert to v5.x non-event-caching behavior.

Hierarchy

LogEventGuardContext
- LoggerTransport

Constructors

constructor

new LoggerTransport(): LoggerTransport
Returns LoggerTransport

Inherited from LogEventGuardContext.constructor

Properties

`Readonly` buffer

buffer: LogEventBuffer = ...

Data source responsible for producing new events, or recycling previously created ones.

guard

guard: LogEventGuard = ...

Methods

accepts

accepts(ev: LogEvent): boolean
Returns true if the underlying guard accepts the given event based on its current mode and custom filter function (if any).
Parameters
- ev: LogEvent
Returns boolean
Inherited from LogEventGuardContext.accepts
- Defined in core/log-event-guard-context.ts:22

addListener

addListener<R>(listener: EventEmitterDelegate<R>): LoggerTransport
Type Parameters
- R extends LogEvent<R> = LogEvent
Parameters
- listener: EventEmitterDelegate<R>
Returns LoggerTransport
- Defined in core/logger-transport.ts:32

createEvent

createEvent(level: number, context: string, message: string, params?: any[], timestamp?: number): LogEvent
Default creator function used by the Logger class.
Parameters
- level: number
- context: string
- message: string
- Optional params: any[]
- Optional timestamp: number
Returns LogEvent
- Defined in core/logger-transport.ts:95

isDefaultBroadcastEnabled

isDefaultBroadcastEnabled(): boolean
Returns boolean
- Defined in core/logger-transport.ts:72

isEnabled

isEnabled(): boolean
Returns true if the underling guard is set to any mode other than BLOCK_ALL.

Returns boolean
Inherited from LogEventGuardContext.isEnabled
- Defined in core/log-event-guard-context.ts:14

pipeTo

pipeTo(other: LoggerTransport): LoggerTransport
Parameters
- other: LoggerTransport
Returns LoggerTransport
- Defined in core/logger-transport.ts:52

pipeToDefault

pipeToDefault(): LoggerTransport
Returns LoggerTransport
- Defined in core/logger-transport.ts:64

removeAllListeners

removeAllListeners(): LoggerTransport
Returns LoggerTransport
- Defined in core/logger-transport.ts:42

removeListener

removeListener<R>(listener: EventEmitterDelegate<R>): LoggerTransport
Type Parameters
- R extends LogEvent<R> = LogEvent
Parameters
- listener: EventEmitterDelegate<R>
Returns LoggerTransport
- Defined in core/logger-transport.ts:37

send

send(ev: LogEvent): void
If the transport can accept the given event, sends the event to all listeners in the events() EventEmitter instance. If the event is not accepted, this does nothing.
Parameters
- ev: LogEvent
Returns void
- Defined in core/logger-transport.ts:104

setDefaultBroadcastEnabled

setDefaultBroadcastEnabled(enabled: boolean): LoggerTransport
Parameters
- enabled: boolean
Returns LoggerTransport
- Defined in core/logger-transport.ts:86

setEnabled

setEnabled(enabled: boolean): LoggerTransport
Set the enabled state of this instance, regarding whether or not it will emit any log events. When true, emits events as normal; when false, suppresses all events.

The main benefit of this is to temorarily suppress all events on this instance, while keeping the currently set filter in-tact.

e.g. If this instance has a custom filter set, and then is disabled, when this is re-enabled later it will continue using the custom filter.
Parameters
- enabled: boolean
Returns LoggerTransport
Inherited from LogEventGuardContext.setEnabled
- Defined in core/log-event-guard-context.ts:49

setFilter

setFilter(value: null | LogEventFilterPredicate): LoggerTransport
Customize which log events should be ignored by this instance. If the given predicate returns truthy, the event will be passed along to any registered listeners or transports; otherwise it will be suppressed.

Pass null to reset the filter.
Parameters
- value: null | LogEventFilterPredicate
Returns LoggerTransport
Inherited from LogEventGuardContext.setFilter
- Defined in core/log-event-guard-context.ts:33

unpipeFrom

unpipeFrom(other: LoggerTransport): LoggerTransport
Parameters
- other: LoggerTransport
Returns LoggerTransport
- Defined in core/logger-transport.ts:59

unpipeFromDefault

unpipeFromDefault(): LoggerTransport
Returns LoggerTransport
- Defined in core/logger-transport.ts:68

Class LoggerTransport

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns LoggerTransport

Properties

Readonly buffer

guard

Methods

accepts

Parameters

ev: LogEvent

Returns boolean

addListener

Type Parameters

R extends LogEvent<R> = LogEvent

Parameters

listener: EventEmitterDelegate<R>

Returns LoggerTransport

createEvent

Parameters

level: number

context: string

message: string

Optional params: any[]

Optional timestamp: number

Returns LogEvent

disableDefaultBroadcast

Returns LoggerTransport

disableEventCaching

Returns LoggerTransport

enableDefaultBroadcast

Returns LoggerTransport

events

Returns EventEmitter<LogEvent>

isDefaultBroadcastEnabled

Returns boolean

isEnabled

Returns boolean

pipeTo

Parameters

other: LoggerTransport

Returns LoggerTransport

pipeToDefault

Returns LoggerTransport

removeAllListeners

Returns LoggerTransport

removeListener

Type Parameters

R extends LogEvent<R> = LogEvent

Parameters

listener: EventEmitterDelegate<R>

Returns LoggerTransport

send

Parameters

ev: LogEvent

Returns void

setDefaultBroadcastEnabled

Parameters

enabled: boolean

Returns LoggerTransport

setEnabled

Parameters

enabled: boolean

Returns LoggerTransport

setFilter

Parameters

value: null | LogEventFilterPredicate

Returns LoggerTransport

unpipeFrom

Parameters

other: LoggerTransport

Returns LoggerTransport

unpipeFromDefault

Returns LoggerTransport

Settings

`Readonly` buffer

`Optional` params: any[]

`Optional` timestamp: number