Class HostedPluginReader

Contribution for hooking into the backend lifecycle:

initialize()
configure(expressApp)
onStart(httpServer)
onStop()

Implements

BackendApplicationContribution

Index

Constructors

Properties

logger pluginsIdsFiles scanner

Methods

configure getPluginMetadata handleMissingResource readContribution readDependencies readMetadata readPackage

Constructors

constructor

new HostedPluginReader(): HostedPluginReader
Returns HostedPluginReader

Properties

`Protected` `Readonly`logger

logger: ILogger

`Protected`pluginsIdsFiles

pluginsIdsFiles: Map<string, string> = ...

Map between a plugin id and its local storage

`Protected` `Readonly`scanner

scanner: MetadataScanner

Methods

configure

configure(app: Application): void
Called after the initialization of the backend application is complete. Use this to configure the Express app before it is started, for example to offer additional endpoints.

The implementation may be async, however it will still block the configuration step until it's resolved.
Parameters
- app: Application
  the express application to configure.
Returns void
either undefined or a Promise resolving to undefined.
Implementation of BackendApplicationContribution.configure
- Defined in packages/plugin-ext/src/hosted/node/plugin-reader.ts:45

getPluginMetadata

getPluginMetadata(
pluginPath: undefined | string,
): Promise<undefined | PluginMetadata>
Parameters
- pluginPath: undefined | string
Returns Promise<undefined | PluginMetadata>
Throws
never
- Defined in packages/plugin-ext/src/hosted/node/plugin-reader.ts:83

`Protected`handleMissingResource

handleMissingResource(req: Request, res: Response): Promise<void>
Parameters
- req: Request
- res: Response
Returns Promise<void>
- Defined in packages/plugin-ext/src/hosted/node/plugin-reader.ts:75

readContribution

readContribution(plugin: PluginPackage): Promise<undefined | PluginContribution>
Parameters
- plugin: PluginPackage
Returns Promise<undefined | PluginContribution>
- Defined in packages/plugin-ext/src/hosted/node/plugin-reader.ts:126

readDependencies

readDependencies(plugin: PluginPackage): undefined | Map<string, string>
Parameters
- plugin: PluginPackage
Returns undefined | Map<string, string>
- Defined in packages/plugin-ext/src/hosted/node/plugin-reader.ts:131

readMetadata

readMetadata(plugin: PluginPackage): Promise<PluginMetadata>
Parameters
- plugin: PluginPackage
Returns Promise<PluginMetadata>
- Defined in packages/plugin-ext/src/hosted/node/plugin-reader.ts:106

readPackage

readPackage(pluginPath: undefined | string): Promise<undefined | PluginPackage>
Parameters
- pluginPath: undefined | string
Returns Promise<undefined | PluginPackage>
- Defined in packages/plugin-ext/src/hosted/node/plugin-reader.ts:93