Class NpmjsPluginRepository

constructor

• new NpmjsPluginRepository(
      __namedParameters: {
          author?: string;
          authToken?: string;
          description?: string;
          name: string;
          packageJsonNamespace: string;
          password?: string;
          registryUrl: string;
          username?: string;
      },
  ): NpmjsPluginRepository

  Parameters

  • __namedParameters: {
        author?: string;
        authToken?: string;
        description?: string;
        name: string;
        packageJsonNamespace: string;
        password?: string;
        registryUrl: string;
        username?: string;
    }

  Returns NpmjsPluginRepository

Optional Readonlyauthor

Optional Readonlydescription

Readonlyname

Readonlyurl

getExtensionDescriptorFromExtensionEntry

• getExtensionDescriptorFromExtensionEntry(
      _extensionEntry: ExtensionEntry,
  ): Promise<Readonly<ExtensionDescriptor>>

  Return the ExtensionDescriptor for the Extension identified by the specified ExtensionEntry.

  Parameters

  • _extensionEntry: ExtensionEntry

  Returns Promise<Readonly<ExtensionDescriptor>>

  an ExtensionDescriptor instance.

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.

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.

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.

search

• search(
      query: Readonly<SearchQuery>,
  ): AsyncIterable<Readonly<VersionedPluginDescriptor>>

  Search for plugins in this marketplace matching the given query.

  The fields searched are provider-defined. Implementations may accept an extended SearchQuery subtype to support additional filter criteria.

  Parameters

  • query: Readonly<SearchQuery>

    the search criteria.

  Returns AsyncIterable<Readonly<VersionedPluginDescriptor>>

  an async iterable of matching VersionedPluginDescriptor instances.