Skip to content

extensions/extensions

Documentation

Overview

Classes

Extensions

getExtensions()

Retrieves the list of extension module paths registered for a specific extension point.

ts
static getExtensions(extensionPoint: string): void;
ParameterTypeDescription
extensionPointstringThe unique identifier of the extension point (e.g., "my.extension.point").

Returns

  • Type: void
  • Description: An array of string paths (modules) registered for the given extension point.

getExtensionPoints()

Retrieves all available extension point identifiers.

ts
static getExtensionPoints(): void;

Returns

  • Type: void
  • Description: An array of strings representing all registered extension point IDs.

loadExtensionModules()

Loads extension modules registered for a specific extension point. It handles both synchronous (require) and asynchronous (import) loading.

ts
static loadExtensionModules(extensionPoint: string, requiredFunctions: any, throwError: boolean): Promise;
ParameterTypeDescription
extensionPointstringThe unique identifier of the extension point.
requiredFunctionsanyAn optional list of function names that the extension module must export to be included.
throwErrorbooleanIf true, throws an error on failure; otherwise, logs the error and continues.

Returns

  • Type: Promise
  • Description: A Promise that resolves to an array of successfully loaded and validated extension modules (exports).

load()

Alias for loadExtensionModules

ts
static load(extensionPoint: string, requiredFunctions: any, throwError: boolean): Promise;
ParameterTypeDescription
extensionPointstring
requiredFunctionsany
throwErrorboolean

Returns

  • Type: Promise
  • Description: