Interface PluginRepository

A source of Plugin implementations.

interface PluginRepository {
    getExtensionDescriptorFromExtensionEntry(
        extensionEntry: ExtensionEntry,
    ): Promise<Readonly<ExtensionDescriptor>>;
    getPlugins(): AsyncIterable<Readonly<PluginDescriptor>>;
    scanForExtensions(
        extensionPoint: string,
    ): AsyncIterable<Readonly<ExtensionEntry>>;
}

Hierarchy (View Summary)

PluginRepository
- VersionedPluginRepository

Implemented by

UrlListPluginRepository

Index

Methods

getExtensionDescriptorFromExtensionEntry 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.
- Defined in api/plugin_repository/PluginRepository.ts:33

getPlugins

getPlugins(): AsyncIterable<Readonly<PluginDescriptor>>
Return a PluginDescriptor for each Plugin hosted in the Plugin Repository.

Returns AsyncIterable<Readonly<PluginDescriptor>>
an async iterable of PluginDescriptor instances.
- Defined in api/plugin_repository/PluginRepository.ts:14

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.
- Defined in api/plugin_repository/PluginRepository.ts:24