Extension

interface Extension<T : JsAny?>(source)

Represents an extension.

To get an instance of an Extension use getExtension.

Online Documentation

Properties

Link copied to clipboard
abstract external val exports: T

The public API exported by this extension (return value of activate). It is an invalid action to access this field before this extension has been activated.

Link copied to clipboard
abstract external var 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 but can also be refined via the remote.extensionKind-setting. When no remote extension host exists, the value is ExtensionKind.UI.

Link copied to clipboard
abstract external val extensionPath: String

The absolute file path of the directory containing this extension. Shorthand notation for Extension.extensionUri.fsPath (independent of the uri scheme).

Link copied to clipboard
abstract external val extensionUri: Uri

The uri of the directory containing the extension.

Link copied to clipboard
abstract external val id: String

The canonical extension identifier in the form of: publisher.name.

Link copied to clipboard
abstract external val isActive: Boolean

true if the extension has been activated.

Link copied to clipboard
abstract external val packageJSON: JsAny?

The parsed contents of the extension's package.json.

Functions

Link copied to clipboard
abstract external fun activate(): PromiseLike<T>

Activates this extension and returns its public API.