feat(router): expose event.context.matchedRoute

README.md

@@ -215,6 +215,8 @@ H3 has a concept of composable utilities that accept `event` (from `eventHandler
 - `getQuery(event)`
 - `getValidatedBody(event, validate)`
 - `getRouterParams(event)`
+- `getRouterParam(event, name)`
+- `getRouterMatchedPath(event)`
 - `getMethod(event, default?)`
 - `isMethod(event, expected, allowHead?)`
 - `assertMethod(event, expected, allowHead?)`

src/router.ts

@@ -36,6 +36,7 @@ export interface Router extends AddRouteShortcuts {
 
 interface RouteNode {
   handlers: Partial<Record<RouterMethod | "all", EventHandler>>;
+  path: string;
 }
 
 export interface CreateRouterOptions {
@@ -60,7 +61,7 @@ export function createRouter(opts: CreateRouterOptions = {}): Router {
   ) => {
     let route = routes[path];
     if (!route) {
-      routes[path] = route = { handlers: {} };
+      routes[path] = route = { handlers: {}, path };
       _router.insert(path, route);
     }
     if (Array.isArray(method)) {
@@ -148,6 +149,10 @@ export function createRouter(opts: CreateRouterOptions = {}): Router {
     const params = matched.params || {};
     event.context.params = params;
 
+    // Add matched path
+    const matchedPath = matched.path || "/";
+    event.context.matchedPath = matchedPath;
+
     // Call handler
     return Promise.resolve(handler(event)).then((res) => {
       if (res === undefined && (opts.preemptive || opts.preemtive)) {

src/types.ts

@@ -37,6 +37,8 @@ export interface H3EventContext extends Record<string, any> {
   params?: Record<string, string>;
   /* Cached session data */
   sessions?: Record<string, Session>;
+  /* Matched router path */
+  path?: string;
 }
 
 export type EventHandlerResponse<T = any> = T | Promise<T>;

src/utils/request.ts

@@ -37,6 +37,12 @@ export function getRouterParam(
   return params[name];
 }
 
+export function getRouterMatchedPath(
+  event: H3Event,
+): NonNullable<H3Event["context"]["matchedPath"]> {
+  return event.context.matchedPath;
+}
+
 /**
  * @deprecated Directly use `event.method` instead.
  */

test/router.test.ts

@@ -7,6 +7,7 @@ import {
   Router,
   getRouterParams,
   getRouterParam,
+  getRouterMatchedPath,
   toNodeListener,
   eventHandler,
 } from "../src";
@@ -247,3 +248,44 @@ describe("getRouterParam", () => {
     });
   });
 });
+
+describe("getMatchedPath", () => {
+  let app: App;
+  let request: SuperTest<Test>;
+
+  beforeEach(() => {
+    app = createApp({ debug: false });
+    request = supertest(toNodeListener(app));
+  });
+
+  describe("with router", () => {
+    it("can return the matched path", async () => {
+      const router = createRouter().get(
+        "/test/:template",
+        eventHandler((event) => {
+          expect(getRouterMatchedPath(event)).toEqual("/test/:template");
+          return "200";
+        }),
+      );
+      app.use(router);
+      const result = await request.get("/test/path");
+
+      expect(result.text).toBe("200");
+    });
+  });
+
+  describe("without router", () => {
+    it("can return `undefined` for matched path", async () => {
+      app.use(
+        "/",
+        eventHandler((event) => {
+          expect(getRouterMatchedPath(event)).toEqual(undefined);
+          return "200";
+        }),
+      );
+      const result = await request.get("/test/path");
+
+      expect(result.text).toBe("200");
+    });
+  });
+});