Interface IControllerMethodInfo

Information about a loaded controller method.

interface IControllerMethodInfo {
    controller: IHttpController<IHttpServer>;
    deprecatedOptions: IControllerRouteDeprecatedOptions;
    function: Func;
    handler: Func;
    method: HttpMethod;
    middlewares: HttpMiddleware[];
    name: string;
    options: Optional<IControllerRouteOptions | ControllerRouteWithBodyOptions>;
    path: HttpRequestPath;
    rawPath: string;
    serializer: Optional<ResponseSerializer<any>>;
    swaggerOperations: {
        callbacks?: {
            [callback: string]: ReferenceObject | CallbackObject;
        };
        deprecated?: boolean;
        description?: string;
        externalDocs?: ExternalDocumentationObject;
        operationId?: string;
        parameters?: (ReferenceObject | ParameterObject)[];
        requestBody?: ReferenceObject | RequestBodyObject;
        responses: ResponsesObject;
        security?: SecurityRequirementObject[];
        servers?: ServerObject[];
        summary?: string;
        tags?: string[];
    }[];
    tests: ITestSettings[];
}

Properties

controller deprecatedOptions function handler method middlewares name options path rawPath serializer swaggerOperations tests

Properties

controller

controller: IHttpController<IHttpServer>

The underlying controller.

deprecatedOptions

deprecatedOptions: IControllerRouteDeprecatedOptions

Deprecated options.

function

function: Func

The underlying base function instance.

handler

handler: Func

The underlying handler function for the server, which is used at the end.

method

method: HttpMethod

The underlying http method.

middlewares

middlewares: HttpMiddleware[]

The middlewares.

name

name: string

The name of the method.

options

options: Optional<IControllerRouteOptions | ControllerRouteWithBodyOptions>

The underlying options.

path

path: HttpRequestPath

The route path.

rawPath

rawPath: string

The raw request path as string.

serializer

serializer: Optional<ResponseSerializer<any>>

The serializer, if defined.

swaggerOperations

swaggerOperations: {
    callbacks?: {
        [callback: string]: ReferenceObject | CallbackObject;
    };
    deprecated?: boolean;
    description?: string;
    externalDocs?: ExternalDocumentationObject;
    operationId?: string;
    parameters?: (ReferenceObject | ParameterObject)[];
    requestBody?: ReferenceObject | RequestBodyObject;
    responses: ResponsesObject;
    security?: SecurityRequirementObject[];
    servers?: ServerObject[];
    summary?: string;
    tags?: string[];
}[]

Underlying swagger operations.

Type declaration

tests

tests: ITestSettings[]

Tests, represented by their settings.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc