Options
All
  • Public
  • Public/Protected
  • All
Menu

This class is used to record and access plugin errors and warnings. It is a singleton and should be accessed via PluginIssues.instance.

Hierarchy

  • PluginIssues

Index

Properties

Private installedPlugins

installedPlugins: IPluginJson = null

The set of installed plugins. We access this class property only through its accompanying function [getInstalledPlugins]{@link PluginIssues#getInstalledPlugins} to ensure that we only read the file once and reduce excessive I/O.

Private pluginIssues

pluginIssues: IPluginIssues

A map containing issues for each plugin for which problems were detected.

Static Private mInstance

mInstance: PluginIssues

This is the variable that stores the specific instance of the PluginIssues. Defined as static so that it can be accessed from anywhere.

Accessors

Static instance

Methods

doesPluginHaveIssueSev

  • doesPluginHaveIssueSev(pluginName: string, issueSevs: IssueSeverity[]): boolean

getAllIssues

getInstalledPlugins

getIssueListForPlugin

recordIssue

  • recordIssue(pluginName: string, issueSev: IssueSeverity, issueText: string): void
  • Record an issue that was discovered in a plugin into an in-memory structure. The plugin issues can later be accessed to report the health of a plugin.

    Parameters

    • pluginName: string

      The name of the plugin

    • issueSev: IssueSeverity

      The severity of the issue. Use PluginIssues.ERROR or PluginIssues.WARNING

    • issueText: string

      The issue message text to record.

    Returns void

removeIssuesForPlugin

  • removeIssuesForPlugin(pluginName: string): void

Generated using TypeDoc