Class BackendApplication

The main entry point for Theia applications.

Index

Constructors

Properties

app cliParams contributionsProvider processUtils stopwatch

Accessors

Methods

configure getHttpUrl handleUncaughtError init initialize measure measureContribution onStop serveGzipped start use

Constructors

constructor

new BackendApplication(
    contributionsProvider: ContributionProvider<
        BackendApplicationContribution,
    >,
    cliParams: BackendApplicationCliContribution,
): BackendApplication
Parameters
- contributionsProvider: ContributionProvider<BackendApplicationContribution>
- cliParams: BackendApplicationCliContribution
Returns BackendApplication
- Defined in packages/core/src/node/backend-application.ts:169

Properties

`Protected` `Readonly`app

app: Application = ...

`Protected` `Readonly`cliParams

cliParams: BackendApplicationCliContribution

`Protected` `Readonly`contributionsProvider

contributionsProvider: ContributionProvider<BackendApplicationContribution>

`Protected` `Readonly`processUtils

processUtils: ProcessUtils

`Protected` `Readonly`stopwatch

stopwatch: Stopwatch

Accessors

configured

get configured(): Promise<void>
Returns Promise<void>
- Defined in packages/core/src/node/backend-application.ts:209

Methods

`Protected`configure

configure(): Promise<void>
Returns Promise<void>
- Defined in packages/core/src/node/backend-application.ts:219

`Protected`getHttpUrl

getHttpUrl(__namedParameters: AddressInfo, ssl?: boolean): string
Parameters
- __namedParameters: AddressInfo
- Optionalssl: boolean
Returns string
- Defined in packages/core/src/node/backend-application.ts:328

`Protected`handleUncaughtError

handleUncaughtError(error: Error): void
Parameters
- error: Error
Returns void
- Defined in packages/core/src/node/backend-application.ts:382

`Protected`init

init(): void
Returns void
- Defined in packages/core/src/node/backend-application.ts:214

`Protected`initialize

initialize(): Promise<void>
Returns Promise<void>
- Defined in packages/core/src/node/backend-application.ts:196

`Protected`measure

measure<T>(name: string, fn: () => MaybePromise<T>): Promise<T>
Type Parameters
- T
Parameters
- name: string
- fn: () => MaybePromise<T>
Returns Promise<T>
- Defined in packages/core/src/node/backend-application.ts:378

`Protected`measureContribution

measureContribution<T>(
    contribution: BackendApplicationContribution,
    hook: string,
    fn: () => MaybePromise<T>,
): Promise<T>
Type Parameters
- T
Parameters
- contribution: BackendApplicationContribution
- hook: string
- fn: () => MaybePromise<T>
Returns Promise<T>
- Defined in packages/core/src/node/backend-application.ts:368

`Protected`onStop

onStop(): void
Returns void
- Defined in packages/core/src/node/backend-application.ts:335

`Protected`serveGzipped

serveGzipped(
    contentType: string,
    req: Request,
    res: Response,
    next: NextFunction,
): Promise<void>
Parameters
- contentType: string
- req: Request
- res: Response
- next: NextFunction
Returns Promise<void>
- Defined in packages/core/src/node/backend-application.ts:350

start

start(
    port?: number,
    hostname?: string,
): Promise<
    | Server<typeof IncomingMessage, typeof ServerResponse>
    | Server<typeof IncomingMessage, typeof ServerResponse>,
>
Parameters
- Optionalport: number
- Optionalhostname: string
Returns Promise<
| Server<typeof IncomingMessage, typeof ServerResponse>
| Server<typeof IncomingMessage, typeof ServerResponse>,
>
- Defined in packages/core/src/node/backend-application.ts:251

use

use(...handlers: Handler[]): void
Parameters
- ...handlers: Handler[]
Returns void
- Defined in packages/core/src/node/backend-application.ts:247