Type Alias RouteConfiguration<BodyMetaObject, PathMetaObject, QueryMetaObject, HeaderMetaObject>

Configuration for a single endpoint route.

type RouteConfiguration<
    BodyMetaObject extends BodyMetadata,
    PathMetaObject extends Record<string, PathParamMetadata>,
    QueryMetaObject extends Record<string, QueryParamMetadata>,
    HeaderMetaObject extends Record<string, HeaderParamMetadata>,
> = {
    bodyMetadata: BodyMetadata | undefined;
    handler: RouteHandler<
        MergeRequired<BodyMetaObject, BodyMetaObject>,
        PathMetaObjectToParamsObject<PathMetaObject>,
        QueryMetaObjectToParamsObject<QueryMetaObject>,
        HeaderMetaObjectToParamsObject<HeaderMetaObject>,
    >;
    headerParams: HeaderMetaObject;
    httpMethod: HttpMethod;
    openApi: OpenApiRouteConfiguration;
    pathParams: PathMetaObject;
    queryParams: QueryMetaObject;
    route: Route;
}

Properties

bodyMetadata: BodyMetadata | undefined

The metadata for the request body.

handler: RouteHandler<
    MergeRequired<BodyMetaObject, BodyMetaObject>,
    PathMetaObjectToParamsObject<PathMetaObject>,
    QueryMetaObjectToParamsObject<QueryMetaObject>,
    HeaderMetaObjectToParamsObject<HeaderMetaObject>,
>

The handler that is responsible for handling requests on the route.

An object of metadata for the header parameters.

httpMethod: HttpMethod

The http method used by the endpoint.

Configuration on how to handle open api.

An object of metadata for the path parameters.

An object of metadata for the query parameters.

route: Route

The actual route under which the endpoint can be reached.