Skip to main content
API module

extensions API

All 8 public APIs exported from the extensions module, with declarations, documentation, and source-backed examples.

Generated from typings/index.d.ts @ 555f5ceon

extensions

extensions.onDidLoadExtension

Fired on extension loaded, extension not activated yet.

Source

API signature

extensions.onDidLoadExtension: Event<Extension<any>>
Returns
Event<Extension<any>>
Declaration
typings/index.d.ts:12390
extensions

extensions.onDidActiveExtension

Fired on extension activated.

Source

API signature

extensions.onDidActiveExtension: Event<Extension<any>>
Returns
Event<Extension<any>>
Declaration
typings/index.d.ts:12395
extensions

extensions.onDidUnloadExtension

Fired with extension id on extension unload.

Source

API signature

extensions.onDidUnloadExtension: Event<string>
Returns
Event<string>
Declaration
typings/index.d.ts:12400
extensions

extensions.all

Get all loaded extensions, without disabled extensions, extension may not activated.

Source

API signature

extensions.all: ReadonlyArray<Extension<any>>
Returns
ReadonlyArray<Extension<any>>
Declaration
typings/index.d.ts:12405
extensions

extensions.getExtensionById

Get an extension by its full identifier in the form of: publisher.name.

Source

API signature

extensions.getExtensionById<T = any>(extensionId: string): Extension<T> | undefined

Parameters

ParameterTypeDescription
extensionIdstring

An extension identifier.

Returns
Extension<T> | undefined

An extension or undefined.

Declaration
typings/index.d.ts:12413
extensions

extensions.getExtensionState

Get state of specific extension.

Source

API signature

extensions.getExtensionState(id: string): ExtensionState

Parameters

ParameterType
idstring
Declaration
typings/index.d.ts:12418
extensions

extensions.getExtensionStates

Get state of all extensions, including disabled extensions.

Source

API signature

extensions.getExtensionStates(): Promise<ExtensionInfo[]>
Returns
Promise<ExtensionInfo[]>
Declaration
typings/index.d.ts:12423
extensions

extensions.isActivated

Check if extension is activated.

Source

API signature

extensions.isActivated(id: string): boolean

Parameters

ParameterType
idstring
Returns
boolean
Declaration
typings/index.d.ts:12428