Interface BackendApplicationServer

This service is responsible for serving the frontend files.

When not bound, @theia/cli generators will bind it on the fly to serve files according to its own layout.

interface BackendApplicationServer {
    configure?(app): MaybePromise<void>;
    initialize?(): MaybePromise<void>;
    onStart?(server): MaybePromise<void>;
    onStop?(app?): void;
}

Hierarchy (view full)

BackendApplicationContribution
- BackendApplicationServer

Index

Methods

configure? initialize? onStart? onStop?

Methods

`Optional` configure

configure(app): MaybePromise<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 MaybePromise<void>
either undefined or a Promise resolving to undefined.
Inherited from BackendApplicationContribution.configure
- Defined in packages/core/src/node/backend-application.ts:90

`Optional` initialize

initialize(): MaybePromise<void>
Called during the initialization of the backend application. Use this for functionality which has to run as early as possible.

The implementation may be async, however it will still block the initialization step until it's resolved.

Returns MaybePromise<void>
either undefined or a Promise resolving to undefined.
Inherited from BackendApplicationContribution.initialize
- Defined in packages/core/src/node/backend-application.ts:76

`Optional` onStart

onStart(server): MaybePromise<void>
Called right after the server for the Express app is started. Use this to additionally configure the server or as ready-signal for your service.

The implementation may be async, however it will still block the startup step until it's resolved.
Parameters
- server: Server<typeof IncomingMessage, typeof ServerResponse> | Server<typeof IncomingMessage, typeof ServerResponse>
  the backend server running the express app.
Returns MaybePromise<void>
either undefined or a Promise resolving to undefined.
Inherited from BackendApplicationContribution.onStart
- Defined in packages/core/src/node/backend-application.ts:103

`Optional` onStop

onStop(app?): void
Called when the backend application shuts down. Contributions must perform only synchronous operations. Any kind of additional asynchronous work queued in the event loop will be ignored and abandoned.
Parameters
- Optional app: Application
  the express application.
Returns void
Inherited from BackendApplicationContribution.onStop
- Defined in packages/core/src/node/backend-application.ts:111