Class ColorConsoleAppender

Appends styled messages to the console. Only available on servers, i.e. terminals supporting colors.

Hierarchy (view full)

ConsoleAppender
- ColorConsoleAppender

Constructors

constructor

new ColorConsoleAppender(format?, timeFormat?, formatLookups?, style?): ColorConsoleAppender
Parameters
- format: string = DefaultFormats.MESSAGE
  The log message format to use. All properties of a log message can be inserted to their placeholders, e.g. '%id%'.
- timeFormat: string = DefaultFormats.TIME
  The time format to use for the %time% placeholder. The time format is inspired by https://msdn.microsoft.com/de-de/library/8kb3ddd4(v=vs.110).aspx, but some of the placeholders might not work.
- Optional formatLookups: FormatLookup
  map containing lookups for the printing of formatted messages, see DefaultFormats
- Optional style: StyleLookup
  map containing style lookups for the printing of coloured messages. The timeStyle defaults to DefaultStyles.TIME; The defaultStyle defaults to DefaultStyles.ORIGIN; The originStyle defaults to DefaultStyles.ORIGIN; The idStyle defaults to DefaultStyles.ID; The messageStyle defaults to DefaultStyles.MESSAGE;
Returns ColorConsoleAppender
Overrides ConsoleAppender.constructor
- Defined in appenders/ColorConsoleAppender.ts:401

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.

`Protected` ageLookup

ageLookup: string[] = DefaultFormats.ENUMS.AGE

see DefaultFormats.ENUMS.AGE

`Protected` autoColors

autoColors: string[] = ...

List of styles to choose from when generating random styles.

`Protected` categoryStyle

categoryStyle: StyleLookupEntry[] = []

Array containing category style rules. Will be generated according to the category style option specified.

`Protected` dayOfTheWeekLookup

dayOfTheWeekLookup: string[] = DefaultFormats.ENUMS.DAY_OF_WEEK

see DefaultFormats.ENUMS.DAY_OF_WEEK

`Protected` defaultStyle

defaultStyle: string = Colors.DEFAULT

See Colors.DEFAULT.

`Protected` format

format: string

The log message format to use. All properties of a log message can be inserted to their placeholders, e.g. '%id%'.

`Protected` idStyle

idStyle: string = DefaultStyles.ID

See DefaultStyles.ID.

`Protected` messageStyle

messageStyle: string = DefaultStyles.MESSAGE

See DefaultStyles.MESSAGE.

`Protected` monthLookup

monthLookup: string[] = DefaultFormats.ENUMS.MONTH

see DefaultFormats.ENUMS.MONTH

`Protected` noonLookup

noonLookup: string[] = DefaultFormats.ENUMS.NOON

see DefaultFormats.ENUMS.NOON

`Protected` originStyle

originStyle: string = DefaultStyles.ORIGIN

See DefaultStyles.ORIGIN.

`Protected` refStyle

refStyle: StyleLookupEntry[] = []

Array containing ref style rules. Will be generated according to the refStyle option specified.

`Protected` separatorLookup

separatorLookup: string[] = DefaultFormats.ENUMS.SEPARATOR

see DefaultFormats.ENUMS.SEPARATOR

`Protected` severityLookup

severityLookup: string[] = DefaultFormats.ENUMS.SEVERITY

A simple lookup from where the strings for the severity levels can be fetched. see DefaultFormats.ENUMS.SEVERITY

`Protected` severityStyle

severityStyle: StyleLookupEntry[] = []

Array containing severity style rules. Will be generated according to the severity style option specified.

`Protected` styleAutoGenerators

styleAutoGenerators: RandomStyleGeneratorFactory[] = []

Array if style auto generator functions, indexed by the RandomizedStylableLogMessageProperties enum values.

`Protected` timeFormat

timeFormat: string

The time format to use for the %time% placeholder. The time format is inspired by https://msdn.microsoft.com/de-de/library/8kb3ddd4(v=vs.110).aspx, but some of the placeholders might not work.

`Protected` timeStyle

timeStyle: string = DefaultStyles.TIME

See DefaultStyles.TIME.

Accessors

buffer

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

filterRelation

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

filters

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

Returns Filter[]
Inherited from ConsoleAppender.filters
- Defined in appenders/IAppender.ts:52

Methods

`Protected` _appendMessage

_appendMessage(str): 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
- str: string
Returns void
Overrides ConsoleAppender._appendMessage
- Defined in appenders/ColorConsoleAppender.ts:658

`Protected` _handleMessage

_handleMessage(msg): void
Transforms the message object according to the format string and forwards the result to the append method.
Parameters
- msg: LogMessage
Returns void
Inherited from ConsoleAppender._handleMessage
- Defined in appenders/FormattedAppender.ts:743

addFilter

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

cleanAnsiStyle

cleanAnsiStyle(str): string
Removes all ansi style sequences from the string.
Parameters
- str: string
  The string to clean from the ansi sequences.
Returns string
Inherited from ConsoleAppender.cleanAnsiStyle
- Defined in appenders/FormattedAppender.ts:751

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
Inherited from ConsoleAppender.clearBuffer
- 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.
Inherited from ConsoleAppender.evalFilters
- Defined in appenders/IAppender.ts:101

`Protected` generateCategoryStyleLookup

generateCategoryStyleLookup(styles?): StyleLookupEntry[]
Generates the default category style lookup.
Parameters
- Optional styles: string | StyleGenerator | CategoryStyle[]
  consumes the StyleLookup.categoryStyle entry. If not specified, the default lookup will be generated.
Returns StyleLookupEntry[]
- Defined in appenders/ColorConsoleAppender.ts:532

`Protected` generateRefStyleLookup

generateRefStyleLookup(styles?): StyleLookupEntry[]
Generates the default ref style lookup.
Parameters
- Optional styles: string | StyleGenerator | RefStyle[]
  consumes the StyleLookup.refStyle entry. If not specified, the default lookup will be generated.
Returns StyleLookupEntry[]
- Defined in appenders/ColorConsoleAppender.ts:486

`Protected` generateSeverityStyleLookup

generateSeverityStyleLookup(styles?): StyleLookupEntry[]
Generates the default severity style lookup.
Parameters
- Optional styles: string | StyleGenerator | SeverityStyle[]
  consumes the StyleLookup.severityStyle entry. If not specified, the default lookup will be generated.
Returns StyleLookupEntry[]
- Defined in appenders/ColorConsoleAppender.ts:444

`Protected` getFormatLookup

getFormatLookup(): FormatLookup
Returns FormatLookup
the options object for the formatTimeString method.
Inherited from ConsoleAppender.getFormatLookup
- Defined in appenders/FormattedAppender.ts:721

getStyle

getStyle(lookup, msg): undefined | string
Returns the style setting selected from the style lookup entries specified. If no filter matches, undefined returned.
Parameters
- lookup: StyleLookupEntry[]
- msg: LogMessage
  The message to get the style string for.
Returns undefined | string
A style string;
- Defined in appenders/ColorConsoleAppender.ts:580

isColorsSupported

isColorsSupported(): boolean
Checks if colors are supported.

Returns boolean
- Defined in appenders/ColorConsoleAppender.ts:596

isWritable

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

Returns boolean
True, if the appender is currently writable, false otherwise
Inherited from ConsoleAppender.isWritable
- Defined in appenders/ConsoleAppender.ts:34

processFormat

processFormat(msg): string
Applies the message format string to the given log message.
Parameters
- msg: LogMessage
Returns string
The formatted message string.
Overrides ConsoleAppender.processFormat
- Defined in appenders/ColorConsoleAppender.ts:600

processMessageParameters

processMessageParameters(msg): null | string
Processes the log message parameters in order to replace the placeholders in the message string.
Parameters
- msg: LogMessage
Returns null | string
The processed message string with inserted message parameters.
Inherited from ConsoleAppender.processMessageParameters
- Defined in appenders/FormattedAppender.ts:736

processTimeFormat

processTimeFormat(msg): string
Applies the time format to the given log message.
Parameters
- msg: LogMessage
Returns string
The formatted message time string
Inherited from ConsoleAppender.processTimeFormat
- Defined in appenders/FormattedAppender.ts:711

`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
Inherited from ConsoleAppender.pushToBuffer
- 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
Inherited from ConsoleAppender.receiveFallBackMessage
- 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.
Inherited from ConsoleAppender.receiveMessage
- Defined in appenders/IAppender.ts:76

Class ColorConsoleAppender

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ColorConsoleAppender

Properties

Protected _buffer

_filterRelation

Protected _filters

Protected ageLookup

Protected autoColors

Protected categoryStyle

Protected dayOfTheWeekLookup

Protected defaultStyle

Protected format

Protected idStyle

Protected messageStyle

Protected monthLookup

Protected noonLookup

Protected originStyle

Protected refStyle

Protected separatorLookup

Protected severityLookup

Protected severityStyle

Protected styleAutoGenerators

Protected timeFormat

Protected timeStyle

Accessors

buffer

Returns LogMessage[]

filterRelation

Parameters

Returns void

filters

Returns Filter[]

Methods

Protected _appendMessage

Parameters

Returns void

Protected _handleMessage

Parameters

Returns void

addFilter

Parameters

Returns void

cleanAnsiStyle

Parameters

Returns string

clearBuffer

Returns void

Protected evalFilters

Parameters

Returns boolean

Protected generateCategoryStyleLookup

Parameters

Returns StyleLookupEntry[]

Protected generateRefStyleLookup

Parameters

Returns StyleLookupEntry[]

Protected generateSeverityStyleLookup

Parameters

Returns StyleLookupEntry[]

Protected getFormatLookup

Returns FormatLookup

getStyle

Parameters

Returns undefined | string

isColorsSupported

Returns boolean

isWritable

Returns boolean

processFormat

Parameters

Returns string

`Protected` _buffer

`Protected` _filters

`Protected` ageLookup

`Protected` autoColors

`Protected` categoryStyle

`Protected` dayOfTheWeekLookup

`Protected` defaultStyle

`Protected` format

`Protected` idStyle

`Protected` messageStyle

`Protected` monthLookup

`Protected` noonLookup

`Protected` originStyle

`Protected` refStyle

`Protected` separatorLookup

`Protected` severityLookup

`Protected` severityStyle

`Protected` styleAutoGenerators

`Protected` timeFormat

`Protected` timeStyle

`Protected` _appendMessage

`Protected` _handleMessage

`Protected` evalFilters

`Protected` generateCategoryStyleLookup

`Protected` generateRefStyleLookup

`Protected` generateSeverityStyleLookup

`Protected` getFormatLookup

`Protected` pushToBuffer