Class IAppender`Abstract`

An appender is the actual output of log messages. For output to the console or to files, the respective subclasses shall be used.

Version

1

Hierarchy (view full)

IAppender

Index

Constructors

Properties

_buffer _filterRelation _filters

Accessors

buffer filterRelation filters

Methods

_appendMessage _handleMessage addFilter clearBuffer evalFilters isWritable pushToBuffer receiveFallBackMessage receiveMessage

Constructors

constructor

new IAppender(filters?, filterRelation?): IAppender
Parameters
- Optional filters: Filter[]
- filterRelation: FilterRelation = FilterRelation.OR
Returns IAppender
- Defined in appenders/IAppender.ts:32

Properties

`Protected` _buffer

_buffer: LogMessage[]

A buffer that will be filled with log messages until the Appender is writable.

_filterRelation

_filterRelation: FilterRelation

The relation, to which all the appenders results must adhere. See FilterRelation.

`Protected` _filters

_filters: Filter[]

The filter that will be evaluated in order to determine whether a message shall be handled by this appender.

Accessors

buffer

get buffer(): LogMessage[]
Returns LogMessage[]
- Defined in appenders/IAppender.ts:28

filterRelation

set filterRelation(relation): void
Parameters
- relation: FilterRelation
Returns void
- Defined in appenders/IAppender.ts:56

filters

get filters(): Filter[]
Returns a copy of the internal filter list.

Returns Filter[]
- Defined in appenders/IAppender.ts:52

Methods

`Protected` `Abstract` _appendMessage

_appendMessage(o): void
This function does the actual appending, e.g. to the console or a file, and thus, must be overriden by subclasses. The default implementation does nothing.
Parameters
- o: string | object | LogMessage
Returns void
- Defined in appenders/IAppender.ts:164

`Protected` _handleMessage

_handleMessage(msg): void
This function forwards the message to the _appendMessage method. The function should be overridden by subclasses for the pre-processing of a log message, e.g. transforming it into a formatted string.
Parameters
- msg: LogMessage
  The message that shall be handled.
Returns void
- Defined in appenders/IAppender.ts:155

addFilter

addFilter(filter): void
Adds a filter to the internal filter list.
Parameters
- filter: Filter | Filter[]
Returns void
- Defined in appenders/IAppender.ts:42

clearBuffer

clearBuffer(): void
Clears the temporary message cache. If the appender is writable, the messages in the cache will be forwarded to the _handleMessage method.

Returns void
- Defined in appenders/IAppender.ts:140

`Protected` evalFilters

evalFilters(msg): boolean
Evaluates the message with respect to the message filters set.
Parameters
- msg: LogMessage
  The message to evaluate.
Returns boolean
True, if the message matches the filters, false otherwise.
- Defined in appenders/IAppender.ts:101

isWritable

isWritable(): boolean
Returns true, if the appender is able to receive messages.

Returns boolean
True, if the appender is currently writable, false otherwise
- Defined in appenders/IAppender.ts:132

`Protected` pushToBuffer

pushToBuffer(msg): void
Pushes a message to the message cache. The buffer is only intended to act as a temporary store until an appender enables its writable state.
Parameters
- msg: LogMessage
Returns void
- Defined in appenders/IAppender.ts:64

receiveFallBackMessage

receiveFallBackMessage(msg): void
Similar to receiveMessage, except the filters are not evaluated.
Parameters
- msg: LogMessage
  The message to receive and append.
Returns void
- Defined in appenders/IAppender.ts:88

receiveMessage

receiveMessage(msg): boolean
The input function of an Appender for any log message. This function calls the filter evaluation, and hands the message over to the _handleMessage method, if the appender is currently writable. If the appender is not writable, the message is stored to the internal buffer.
Parameters
- msg: LogMessage
  The message that shall be received and appended.
Returns boolean
True, if the message was handled, false otherwise.
- Defined in appenders/IAppender.ts:76