Class LogEventGuardContext

Base class for entities that want to be able to filter log event instances.

Hierarchy

LogEventGuardContext
- LoggerTransport
- Logger

Index

Constructors

Properties

Methods

accepts isEnabled setEnabled setFilter

Constructors

constructor

new LogEventGuardContext(): LogEventGuardContext
Returns LogEventGuardContext

Properties

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
- Defined in core/log-event-guard-context.ts:22

isEnabled

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

Returns boolean
- Defined in core/log-event-guard-context.ts:14

setEnabled

setEnabled(enabled: boolean): LogEventGuardContext
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 LogEventGuardContext
- Defined in core/log-event-guard-context.ts:49

setFilter

setFilter(value: null | LogEventFilterPredicate): LogEventGuardContext
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 LogEventGuardContext
- Defined in core/log-event-guard-context.ts:33

Generated using TypeDoc