Class Plugin<T>

Represents an plugin.

To get an instance of an Plugin use getPlugin.

Type Parameters

T

Hierarchy (View Summary)

Plugin
- PluginExt

Implements

Plugin<T>

Index

Constructors

Properties

id packageJSON pluginPath pluginType pluginUri

Accessors

exports isActive

Methods

Constructors

constructor

new Plugin<T>(pluginManager: PluginManager, plugin: Plugin): Plugin<T>
Type Parameters
- T
Parameters
- pluginManager: PluginManager
- plugin: Plugin
Returns Plugin<T>
- Defined in packages/plugin-ext/src/plugin/plugin-context.ts:1667

Properties

id

id: string

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

packageJSON

packageJSON: any

eslint-disable-next-line @typescript-eslint/no-explicit-any

pluginPath

pluginPath: string

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

pluginType

pluginType: PluginType

pluginUri

pluginUri: Uri

The uri of the directory containing this plug-in.

Accessors

exports

get 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.

Returns T
Implementation of Plugin.exports
- Defined in packages/plugin-ext/src/plugin/plugin-context.ts:1687

isActive

get isActive(): boolean
true if the plug-in has been activated.

Returns boolean
Implementation of Plugin.isActive
- Defined in packages/plugin-ext/src/plugin/plugin-context.ts:1683

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.
Implementation of Plugin.activate
- Defined in packages/plugin-ext/src/plugin/plugin-context.ts:1691