Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogEvent<T>

Type parameters

  • T

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new LogEvent(toLog: string | Effect<any>[] | Effect<any>, x1?: number, y1?: number, x2?: number, y2?: number): LogEvent

  • Abstract class constructor for a Log Event. Registers event time.

    Parameters

    • toLog: string | Effect<any>[] | Effect<any>

      The string, object, or array of objects to be logged

    • Optional x1: number

      Initial x position, if applicable

    • Optional y1: number

      Initial y position, if applicable

    • Optional x2: number

      Final x position, if applicable

    • Optional y2: number

      Final y position, if applicable

    Returns LogEvent

Properties

Private _date

_date: string

Private _dateTime

_dateTime: string

Private _tag

_tag: string

Private _time

_time: string

Private _toLog

_toLog: string | Effect<any>[] | Effect<any>

Private _x1

_x1: number

Private _x2

_x2: number

Private _y1

_y1: number

Private _y2

_y2: number

Accessors

dateTime

  • get dateTime(): string

tag

  • get tag(): string
  • set tag(tag: string): void

toLog

x1

  • get x1(): number

x2

  • get x2(): number

y1

  • get y1(): number

y2

  • get y2(): number

Methods

Abstract assembleLog

  • assembleLog(): string

Abstract eventType

  • eventType(): string

logItem

  • logItem(toLog: string): string

  • Attaches date and time to log message

    Parameters

    • toLog: string

      The log message

    Returns string

Abstract logRemotely

  • logRemotely(uid: string, data: string, checkpoint: string, parses: boolean, doNotLog: boolean, time?: string): void

  • Parameters

    • uid: string
    • data: string
    • checkpoint: string
    • parses: boolean
    • doNotLog: boolean
    • Optional time: string

    Returns void

Abstract toJSON

  • toJSON(): string

Static getNewTime

  • getNewTime(): string

Static logToRemoteServer

  • logToRemoteServer(eventtype: string, uid: string, data: string, checkpoint: string, parses: boolean, doNotLog: boolean, time?: string): void

  • Logs to a remote server.

    Parameters

    • eventtype: string
    • uid: string
    • data: string
    • checkpoint: string
    • parses: boolean
    • doNotLog: boolean
    • Optional time: string

    Returns void

Generated using TypeDoc