Theia API Documentation v1.74.0
    Preparing search index...

    Contribution for hooking into the backend lifecycle:

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

    Implements

    Index

    Constructors

    Properties

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

    Map between a plugin id and its local storage

    Methods

    • 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.

    • Resolves filePath under localPath, with fallback to .js, .cjs and .mjs extensions. Returns undefined if the resolved path is not under localPath or if no candidate exists on disk.

      The extension fallback handles cases where plugins reference modules without extensions, which is common in Node.js/CommonJS environments.

      Parameters

      • localPath: string
      • filePath: string

      Returns Promise<undefined | string>