Class PluginExt<T>

Represents a Theia plugin as well as a VSCode extension.

Type Parameters

Hierarchy (View Summary)

Plugin<T>
- PluginExt

Implements

ExtensionPlugin<T>

Index

Constructors

constructor

new PluginExt<T>(
    pluginManager: PluginManager,
    plugin: Plugin,
    isFromDifferentExtensionHost?: boolean,
): PluginExt<T>
Type Parameters
- T
Parameters
- pluginManager: PluginManager
- plugin: Plugin
- isFromDifferentExtensionHost: boolean = false
Returns PluginExt<T>
Overrides Plugin.constructor
- Defined in packages/plugin-ext/src/plugin/plugin-context.ts:1704

Properties

extensionKind

extensionKind: ExtensionKind

The extension kind describes if an extension runs where the UI runs or if an extension runs where the remote extension host runs. The extension kind is defined in the package.json-file of extensions. When no remote extension host exists, the value is ExtensionKind.UI.

extensionPath

extensionPath: string

The absolute file path of the directory containing this extension. Same as theia.Plugin.pluginPath.

extensionUri

extensionUri: Uri

The uri of the directory containing the extension. Same as theia.Plugin.pluginUri.

id

id: string

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

isFromDifferentExtensionHost

isFromDifferentExtensionHost: boolean

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 ExtensionPlugin.exports
Overrides Plugin.exports
- Defined in packages/plugin-ext/src/plugin/plugin-context.ts:1718

isActive

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

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

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 ExtensionPlugin.activate
Overrides Plugin.activate
- Defined in packages/plugin-ext/src/plugin/plugin-context.ts:1722

Class PluginExt<T>

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns PluginExt<T>

Properties

extensionKind

extensionPath

extensionUri

id

isFromDifferentExtensionHost

packageJSON

pluginPath

pluginType

pluginUri

Accessors

exports

Returns T

isActive

Returns boolean

Methods

activate

Returns PromiseLike<T>

Settings

On This Page