Class LoggerImpl

An implementation of the logger

Implements

Logger

Index

Constructors

Properties

frontVersion ongoingBindings serverAddress sessionID writeConsole

Methods

formatError logBindingEnd logBindingErr logBindingMsg logBindingStart logCmdErr logCmdMsg logInteractionErr logInteractionMsg processLoggingData

Constructors

constructor

new LoggerImpl(version?): LoggerImpl
Parameters
- Optional version: string
Returns LoggerImpl
- Defined in impl/logging/LoggerImpl.ts:106

Properties

`Readonly` frontVersion

frontVersion: undefined | string

The version of the app

ongoingBindings

ongoingBindings: UsageLog[]

serverAddress

serverAddress: undefined | string

The HTTP address of the logging server

`Readonly` sessionID

sessionID: string

The ID of the current session

writeConsole

writeConsole: boolean

States whether messages are logged in the command

Methods

`Private` formatError

formatError(ex): string
Parameters
- ex: unknown
Returns string
- Defined in impl/logging/LoggerImpl.ts:129

logBindingEnd

logBindingEnd(bindingName, cancelled): void
Parameters
- bindingName: string
- cancelled: boolean
Returns void
Implementation of Logger.logBindingEnd
- Defined in impl/logging/LoggerImpl.ts:170

logBindingErr

logBindingErr(msg, ex, bindingName?): void
Logs binding errors. The logging system does not decide the information messages to log. Errors are always logged in.
Parameters
- msg: string
  The message to log
- ex: unknown
  The error
- bindingName: string = ""
  The name of the binding to log
Returns void
Implementation of Logger.logBindingErr
- Defined in impl/logging/LoggerImpl.ts:136

logBindingMsg

logBindingMsg(msg, bindingName?): void
Logs binding information messages. The logging system does not decide the information messages to log. This is the job of each binding in which we can log information or not.
Parameters
- msg: string
  The message to log
- bindingName: string = ""
  The name of the binding to log
Returns void
Implementation of Logger.logBindingMsg
- Defined in impl/logging/LoggerImpl.ts:141

logBindingStart

logBindingStart(bindingName): void
Parameters
- bindingName: string
Returns void
Implementation of Logger.logBindingStart
- Defined in impl/logging/LoggerImpl.ts:166

logCmdErr

logCmdErr(msg, ex, cmdName?): void
Logs command errors. The logging system does not decide the information messages to log. Errors are always logged in.
Parameters
- msg: string
  The message to log
- ex: unknown
  The error
- cmdName: string = ""
  The name of the command
Returns void
Implementation of Logger.logCmdErr
- Defined in impl/logging/LoggerImpl.ts:146

logCmdMsg

logCmdMsg(msg, cmdName?): void
Logs command production information messages. The logging system does not decide the information messages to log. This is the job of each binding in which we can log command information or not.
Parameters
- msg: string
  The message to log
- cmdName: string = ""
  The name of the command
Returns void
Implementation of Logger.logCmdMsg
- Defined in impl/logging/LoggerImpl.ts:151

logInteractionErr

logInteractionErr(msg, ex, interactionName?): void
Logs interaction errors. The logging system does not decide the information messages to log. Errors are always logged in.
Parameters
- msg: string
  The message to log
- ex: unknown
  The error
- interactionName: string = ""
  The name of the interaction
Returns void
Implementation of Logger.logInteractionErr
- Defined in impl/logging/LoggerImpl.ts:156

logInteractionMsg

logInteractionMsg(msg, interactionName?): void
Logs interaction information messages. The logging system does not decide the information messages to log. This is the job of each interaction (and its FSM) in which we can log information or not.
Parameters
- msg: string
  The message to log
- interactionName: string = ""
  The interaction name
Returns void
Implementation of Logger.logInteractionMsg
- Defined in impl/logging/LoggerImpl.ts:161

`Private` processLoggingData

processLoggingData(data): void
Parameters
- data: LoggingData
Returns void
- Defined in impl/logging/LoggerImpl.ts:115

Generated using TypeDoc