Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface EventLogInstance

Represents an event log, which logs information, errors, and warnings.

Hierarchy

  • EventLogInstance

Index

Properties

Methods

Properties

events

events: EventLogRecord[]

Contains all recorded events.

limits

limits: { eventCount: number }

Event log limits.

Type declaration

  • eventCount: number

    Maximum number of events.

silenced

silenced: boolean

Whether this event log is silenced.

Silenced event logs will not produce event records.

Methods

log

  • log(message: string, source: string, severity?: "warning" | "error" | "info" | "none"): void

  • Logs a new event.

    Parameters

    • message: string

      The message to use for this event.

    • source: string

      Event source.

    • Optional severity: "warning" | "error" | "info" | "none"

      The event severity. Default is "none".

    Returns void

setSilenced

  • setSilenced(val: boolean): void

  • Sets whether to silence the event log.

    Parameters

    • val: boolean

      The value.

    Returns void

Generated using TypeDoc