Interface VersionedPluginRepository

A PluginRepository that exposes versioning metadata for its plugins via a backing store (e.g. a manifest file or package.json) without requiring each plugin module to be loaded.

Narrows the return type of PluginRepository.getPlugins to VersionedPluginDescriptor.

interface VersionedPluginRepository {
    getExtensionDescriptorFromExtensionEntry(
        extensionEntry: ExtensionEntry,
    ): Promise<Readonly<ExtensionDescriptor>>;
    getPlugin(
        pluginId: string,
    ): Promise<Readonly<VersionedPluginDescriptor> | undefined>;
    getPlugins(): AsyncIterable<Readonly<VersionedPluginDescriptor>>;
    scanForExtensions(
        extensionPoint: string,
    ): AsyncIterable<Readonly<ExtensionEntry>>;
}

Hierarchy (View Summary)

PluginRepository
- VersionedPluginRepository
  - MarketplacePluginRepository

Implemented by

Index

Methods

getExtensionDescriptorFromExtensionEntry getPlugin getPlugins scanForExtensions

Methods

getExtensionDescriptorFromExtensionEntry

getExtensionDescriptorFromExtensionEntry(
extensionEntry: ExtensionEntry,
): Promise<Readonly<ExtensionDescriptor>>
Return the ExtensionDescriptor for the Extension identified by the specified ExtensionEntry.
Parameters
- extensionEntry: ExtensionEntry
  the ExtensionEntry for the desired Extension.
Returns Promise<Readonly<ExtensionDescriptor>>
an ExtensionDescriptor instance.
Inherited from PluginRepository.getExtensionDescriptorFromExtensionEntry
- Defined in api/plugin_repository/PluginRepository.ts:33

getPlugin

getPlugin(
pluginId: string,
): Promise<Readonly<VersionedPluginDescriptor> | undefined>
Return a VersionedPluginDescriptor for a single named plugin, sourcing version and dependency metadata from the backing store without loading the plugin module. Implementations should perform a targeted lookup rather than scanning the full result of getPlugins.
Parameters
- pluginId: string
  the plugin ID to look up (as returned by VersionedPluginDescriptor.pluginId).
Returns Promise<Readonly<VersionedPluginDescriptor> | undefined>
the matching VersionedPluginDescriptor, or undefined if not found.
- Defined in api/plugin_repository/VersionedPluginRepository.ts:28

getPlugins

getPlugins(): AsyncIterable<Readonly<VersionedPluginDescriptor>>
Return a VersionedPluginDescriptor for each Plugin hosted in this repository, sourcing version and dependency metadata from the backing store.

Returns AsyncIterable<Readonly<VersionedPluginDescriptor>>
an async iterable of VersionedPluginDescriptor instances.
Overrides PluginRepository.getPlugins
- Defined in api/plugin_repository/VersionedPluginRepository.ts:17

scanForExtensions

scanForExtensions(
extensionPoint: string,
): AsyncIterable<Readonly<ExtensionEntry>>
Return an ExtensionEntry for each Extension hosted in the Plugin Repository which provides an Extension for the specified Extension Point.
Parameters
- extensionPoint: string
  the Extension Point for which to return ExtensionEntry instances.
Returns AsyncIterable<Readonly<ExtensionEntry>>
an async iterable of ExtensionEntry instances for all matching Extensions.
Inherited from PluginRepository.scanForExtensions
- Defined in api/plugin_repository/PluginRepository.ts:24

Interface VersionedPluginRepository

Hierarchy (View Summary)

Implemented by

Index

Methods

Methods

getExtensionDescriptorFromExtensionEntry

Parameters

Returns Promise<Readonly<ExtensionDescriptor>>

getPlugin

Parameters

Returns Promise<Readonly<VersionedPluginDescriptor> | undefined>

getPlugins

Returns AsyncIterable<Readonly<VersionedPluginDescriptor>>

scanForExtensions

Parameters

Returns AsyncIterable<Readonly<ExtensionEntry>>

Settings

On This Page