Class Logger

A simple logger class.

Hierarchy

Logger

Index

Constructors

Properties

_capture _historySize _level destination formatter history

Accessors

Methods

_log capture child debug error fatal info trace warn colorFormatter jsonFormatter stringFormatter systemdFormatter

Constructors

constructor

new Logger(options?): Logger
Parameters
- options: {
      destination?: WriteStream;
      formatter?: LogFormatter;
      historySize?: number;
      level?: string;
  } = {}
  - Optional destination?: WriteStream
  - Optional formatter?: LogFormatter
  - Optional historySize?: number
  - Optional level?: string
Returns Logger
- Defined in mojo.js-main/src/logger.ts:46

Properties

_capture

_capture: undefined | CapturedLogs = undefined

_historySize

_historySize: undefined | number

_level

_level: number = 7

destination

destination: WritableStream

Log destination stream.

formatter

formatter: LogFormatter

Log formatter.

history

history: LogEvent[] = []

The last few logged messages.

Accessors

level

get level(): string
Currently active log level.

Returns string
- Defined in mojo.js-main/src/logger.ts:144
set level(level): void
Parameters
- level: string
Returns void
- Defined in mojo.js-main/src/logger.ts:148

Methods

_log

_log(level, msg, context?): void
Parameters
- level: string
- msg: string
- Optional context: LogContext
Returns void
- Defined in mojo.js-main/src/logger.ts:167

capture

capture(level?): CapturedLogs
Capture log messages for as long as the returned object has not been stopped, useful for testing log messages.
Parameters
- level: string = ...
Returns CapturedLogs
- Defined in mojo.js-main/src/logger.ts:59

child

child(context): ChildLogger
Create a child logger that will include context information with every log message.
Parameters
- context: LogContext
Returns ChildLogger
- Defined in mojo.js-main/src/logger.ts:76

debug

debug(msg, context?): void
Log debug message.
Parameters
- msg: string
- Optional context: LogContext
Returns void
- Defined in mojo.js-main/src/logger.ts:93

error

error(msg, context?): void
Log error message.
Parameters
- msg: string
- Optional context: LogContext
Returns void
- Defined in mojo.js-main/src/logger.ts:116

fatal

fatal(msg, context?): void
Log fatal message.
Parameters
- msg: string
- Optional context: LogContext
Returns void
- Defined in mojo.js-main/src/logger.ts:123

info

info(msg, context?): void
Log infor message.
Parameters
- msg: string
- Optional context: LogContext
Returns void
- Defined in mojo.js-main/src/logger.ts:130

trace

trace(msg, context?): void
Log trace message.
Parameters
- msg: string
- Optional context: LogContext
Returns void
- Defined in mojo.js-main/src/logger.ts:156

warn

warn(msg, context?): void
Log warn message.
Parameters
- msg: string
- Optional context: LogContext
Returns void
- Defined in mojo.js-main/src/logger.ts:163

`Static` colorFormatter

colorFormatter(data): string
Log formatter with color highlighting.
Parameters
- data: LogEvent
Returns string
- Defined in mojo.js-main/src/logger.ts:83

`Static` jsonFormatter

jsonFormatter(data): string
JSON log formatter.
Parameters
- data: LogEvent
Returns string
- Defined in mojo.js-main/src/logger.ts:137

`Static` stringFormatter

stringFormatter(data): string
Log formatter without color highlighting.
Parameters
- data: LogEvent
Returns string
- Defined in mojo.js-main/src/logger.ts:100

`Static` systemdFormatter

systemdFormatter(data): string
Log formatter for systemd.
Parameters
- data: LogEvent
Returns string
- Defined in mojo.js-main/src/logger.ts:108

Generated using TypeDoc