Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Plugin<T>

Represents an plugin.

To get an instance of an Plugin use getPlugin.

Type parameters

  • T

Hierarchy

  • Plugin

Index

Properties

Methods

Properties

exports

exports: T

The public API exported by this plug-in. It is an invalid action to access this field before this plug-in has been activated.

id

id: string

The canonical plug-in identifier in the form of: publisher.name.

isActive

isActive: boolean

true if the plug-in has been activated.

packageJSON

packageJSON: any

The parsed contents of the plug-in's package.json.

pluginPath

pluginPath: string

The absolute file path of the directory containing this plug-in.

pluginType

pluginType: PluginType

Methods

activate

  • activate(): PromiseLike<T>

  • Activates this plug-in and returns its public API.

    Returns PromiseLike<T>

    A promise that will resolve when this plug-in has been activated.