implements custom parameter placeholders

kruschid · Sep 10, 2024 · ed6cdc7 · ed6cdc7
1 parent e6877c7
commit ed6cdc7
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 4 deletions.
diff --git a/src/context.ts b/src/context.ts
@@ -8,7 +8,8 @@ export const renderTemplate = ({
     .map((pathSegment) =>
       typeof pathSegment === "string"
         ? pathSegment
-        : `:${pathSegment.name}${pathSegment.kind === "optional" ? "?" : ""}`
+        : pathSegment.options?.template ??
+          `:${pathSegment.name}${pathSegment.kind === "optional" ? "?" : ""}`
     )
     .join("/");
 

diff --git a/src/params.ts b/src/params.ts
@@ -1,15 +1,24 @@
-import type { Param, Parser } from "./types";
+import type { Param, ParamOptions, Parser } from "./types";
 
 export const param = <T>(parser: Parser<T>) => {
-  const fn = <N extends string>(name: N): Param<N, T, "required"> => ({
+  const fn = <N extends string>(
+    name: N,
+    options?: ParamOptions
+  ): Param<N, T, "required"> => ({
     name,
     parser,
     kind: "required",
+    options,
   });
-  fn.optional = <N extends string>(name: N): Param<N, T, "optional"> => ({
+
+  fn.optional = <N extends string>(
+    name: N,
+    options?: ParamOptions
+  ): Param<N, T, "optional"> => ({
     name,
     parser,
     kind: "optional",
+    options,
   });
   return fn;
 };

diff --git a/src/types.ts b/src/types.ts
@@ -6,8 +6,13 @@ export type ParamKind = "optional" | "required";
 
 export type AnyParam = Param<string, any, any>;
 
+export interface ParamOptions {
+  template?: string;
+}
+
 export type Param<N = string, T = any, K extends ParamKind = "required"> = {
   name: N;
+  options?: ParamOptions;
   kind: K;
   parser: Parser<T>;
 };

diff --git a/test/test.ts b/test/test.ts
@@ -47,6 +47,23 @@ test("templates with default renderer", (t) => {
   t.equal(routes.blog._.category._wildcard.$template(), "category/:cid/**");
   t.equal(routes.blog._.category.date.$template(), "category/:cid/:date");
   t.equal(routes.blog.category._.date.$template(), ":date");
+
+  t.end();
+});
+
+test("custom templates with default renderer ", (t) => {
+  const routes = createRoutes({
+    customTemplate: {
+      template: "segment/:param/segment",
+    },
+    customParamTemplate: {
+      path: ["segment", str("title", { template: ":title.(mp4|mov)" })],
+    },
+  });
+
+  t.equal(routes.customTemplate.$template(), "/segment/:param/segment");
+  t.equal(routes.customParamTemplate.$template(), "/segment/:title.(mp4|mov)");
+
   t.end();
 });