Class MainController

Hierarchy (View Summary, Expand)

controller
- MainController

Index

Constructors

constructor

Methods

index response status

Constructors

constructor

new MainController(application: Application): MainController
Parameters
- application: Application
Returns MainController
Inherited from controller.constructor
- Defined in src/framework/typescript/api/http/Controller.ts:24

Properties

`Protected` `Readonly`application

application: Application

`Protected` `Readonly`configManager

configManager: configurationManager

Methods

index

index(): { message: string }
Returns { message: string }
- Defined in src/main/typescript/api/controllers/MainController.ts:31

`Protected`response

response(
    status: number,
    body?: unknown,
    headers?: Record<string, string>,
): response<unknown>
Parameters
- status: number
- Optionalbody: unknown
- Optionalheaders: Record<string, string>
Returns response<unknown>
Inherited from controller.response
- Defined in src/framework/typescript/api/http/Controller.ts:28

status

status(
    request: Request,
): {
    description: undefined | string;
    ip: undefined | string;
    started: Date;
    status:
        | "error"
        | "operational"
        | "degraded"
        | "partial_outage"
        | "major_outage"
        | "maintenance";
}
Parameters
- request: Request
Returns {
    description: undefined | string;
    ip: undefined | string;
    started: Date;
    status:
        | "error"
        | "operational"
        | "degraded"
        | "partial_outage"
        | "major_outage"
        | "maintenance";
}
- Defined in src/main/typescript/api/controllers/MainController.ts:38

Class MainController

Hierarchy (View Summary, Expand)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns MainController

Properties

`Protected` `Readonly`application

`Protected` `Readonly`configManager

Methods

index

Returns { message: string }

`Protected`response

Parameters

Returns response<unknown>

status

Parameters

Returns {
    description: undefined | string;
    ip: undefined | string;
    started: Date;
    status:
        | "error"
        | "operational"
        | "degraded"
        | "partial_outage"
        | "major_outage"
        | "maintenance";
}

Settings

On This Page

Class MainController

Hierarchy (View Summary, Expand)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns MainController

Properties

Protected Readonlyapplication

Protected ReadonlyconfigManager

Methods

index

Returns { message: string }

Protectedresponse

Parameters

Returns response<unknown>

status

Parameters

Returns { description: undefined | string; ip: undefined | string; started: Date; status: | "error" | "operational" | "degraded" | "partial_outage" | "major_outage" | "maintenance";}

Settings

On This Page

`Protected` `Readonly`application

`Protected` `Readonly`configManager

`Protected`response

Returns {
description: undefined | string;
ip: undefined | string;
started: Date;
status:
| "error"
| "operational"
| "degraded"
| "partial_outage"
| "major_outage"
| "maintenance";
}