Type Alias IHttpRouterBase

Type declaration

• endpoint:function

  • endpoint(endpoint: IHttpEndpoint): IHttpRouterBase

  • Registers a single endpoint with fully typed request data inference.

    Parameters

    • endpoint: IHttpEndpoint

      The endpoint definition.

    Returns IHttpRouterBase

    The router instance for chaining.

• group:function

  • group(group: HttpRouteGroup): IHttpRouterBase

  • Groups a set of routes together.

    Parameters

    • group: HttpRouteGroup

      A callback that receives a sub-router to register routes on.

    Returns IHttpRouterBase

    The router instance for chaining.
  • group(prefix: string, group: HttpRouteGroup): IHttpRouterBase

  • Groups a set of routes under a path prefix.

    Parameters

    • prefix: string

      The URL prefix for this route group (e.g. "/api/v1").
    • group: HttpRouteGroup

      A callback that receives a sub-router to register routes on.

    Returns IHttpRouterBase

    The router instance for chaining.

• use:function

  • use(middleware: HttpMiddleware): IHttpRouterBase

  • Registers one or more type-safe middleware handlers that apply to multiple routes.

    Use this method for cross-cutting concerns like authentication, logging, or rate-limiting that should run across several endpoints.

    For middleware that should run on only one endpoint, set the IHttpEndpoint.middlewares property directly on that endpoint definition instead — this scopes the middleware to that route alone and prevents it from affecting other endpoints.

    Parameters

    • middleware: HttpMiddleware

      One or more middleware registrations.

    Returns IHttpRouterBase

    The router instance for chaining.