Class LogEventGuard

Gate-keeping mechanism for log events. The primary entry point is the accepts() method.

Hierarchy

LogEventGuard

Index

Constructors

Properties

Accessors

Methods

accepts filterAccepts setFilter setMode

Constructors

constructor

new LogEventGuard(): LogEventGuard
Returns LogEventGuard

Properties

mode

mode: LogEventGuardMode = LogEventGuardMode.DEFAULT

Accessors

filter

get filter(): LogEventFilterPredicate
Currently set filter function. Defaults to tautology and performs no event suppression.

Returns LogEventFilterPredicate
- Defined in core/log-event-guard.ts:38
set filter(value: null | LogEventFilterPredicate): void
Parameters
- value: null | LogEventFilterPredicate
Returns void
- Defined in core/log-event-guard.ts:42

Methods

accepts

accepts(ev: LogEvent): boolean
Returns true if this guard accepts the given event based on its current mode and filter function.
Parameters
- ev: LogEvent
Returns boolean
- Defined in core/log-event-guard.ts:68

filterAccepts

filterAccepts(ev: LogEvent): boolean
Returns true if this guard accepts the given event based only on its current filter function (mode is ignored).
Parameters
- ev: LogEvent
Returns boolean
- Defined in core/log-event-guard.ts:60

setFilter

setFilter(value: null | LogEventFilterPredicate): LogEventGuard
Parameters
- value: null | LogEventFilterPredicate
Returns LogEventGuard
- Defined in core/log-event-guard.ts:46

setMode

setMode(mode: LogEventGuardMode): LogEventGuard
Parameters
- mode: LogEventGuardMode
Returns LogEventGuard
- Defined in core/log-event-guard.ts:51

Generated using TypeDoc