Interface IControllersResult

Result of an IHttpServer.controllers() call.

interface IControllersResult {
    app: IHttpServer;
    documentation: Document<{}>;
    isSwaggerUIEnabled: boolean;
    methods: IControllerMethodInfo[];
    getTests(options?): Promise<IHttpControllerTest[]>;
}

Index

Properties

app documentation isSwaggerUIEnabled methods

Methods

Properties

app

app: IHttpServer

The underlying app / server.

documentation

documentation: Document<{}>

The swagger documentation.

Type declaration

isSwaggerUIEnabled

isSwaggerUIEnabled: boolean

Indicates if Swagger UI is enabled or not.

methods

methods: IControllerMethodInfo[]

Controller methods.

Methods

getTests

getTests(options?): Promise<IHttpControllerTest[]>
Resolves a list of all tests.
Parameters
- Optional options: IGetTestsOptions
Returns Promise<IHttpControllerTest[]>
The promise with the tests.
- Defined in src/types/index.ts:867

Generated using TypeDoc