Interface Logger

The logging system for Interacto

interface Logger {
    frontVersion: undefined | string;
    serverAddress: undefined | string;
    sessionID: string;
    writeConsole: boolean;
    logBindingEnd(bindingName, cancelled): void;
    logBindingErr(msg, ex, bindingName?): void;
    logBindingMsg(msg, bindingName?): void;
    logBindingStart(bindingName): void;
    logCmdErr(msg, ex, cmdName?): void;
    logCmdMsg(msg, cmdName?): void;
    logInteractionErr(msg, ex, interactionName?): void;
    logInteractionMsg(msg, interactionName?): void;
}

Implemented by

Properties

frontVersion serverAddress sessionID writeConsole

Methods

logBindingEnd logBindingErr logBindingMsg logBindingStart logCmdErr logCmdMsg logInteractionErr logInteractionMsg

Properties

Readonly frontVersion

frontVersion: undefined | string

The version of the app

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

logBindingEnd

  • logBindingEnd(bindingName, cancelled): void

  • Parameters

    • bindingName: string
    • cancelled: boolean

    Returns void

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

    • Optional bindingName: string

      The name of the binding to log

    Returns void

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

    • Optional bindingName: string

      The name of the binding to log

    Returns void

logBindingStart

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

    • Optional cmdName: string

      The name of the command

    Returns void

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

    • Optional cmdName: string

      The name of the command

    Returns void

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

    • Optional interactionName: string

      The name of the interaction

    Returns void

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

    • Optional interactionName: string

      The interaction name

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc