Interface RouteDefinition

Metadata for defining routes using decorators. RouteDefinition

interface RouteDefinition {
    method: HttpMethod;
    middlewares?: Handler<
        Record<string, string>,
        Record<string, string>,
        JsonValue,
        JsonValue,
    >[];
    path: string;
    propertyKey: string;
    schema?: RouteSchema;
}

Properties

The HTTP method for the route.

middlewares?: Handler<
    Record<string, string>,
    Record<string, string>,
    JsonValue,
    JsonValue,
>[]

Middlewares to run before the route handler.

path: string

The URL path pattern for the route.

propertyKey: string

The name of the controller method handling the route.

Metadata describing the route's schema.