Merge pull request #882 from BitGo/DX-703

feat: add type error if path doesn't start with /
BitGo · Aug 23, 2024 · 64dc7af · 64dc7af
2 parents 3a9a0f4 + a27e388
commit 64dc7af
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/packages/io-ts-http/src/httpRoute.ts b/packages/io-ts-http/src/httpRoute.ts
@@ -13,8 +13,10 @@ export const Method = t.keyof({
 
 export type Method = t.TypeOf<typeof Method>;
 
+export type PathString = `/${string}`;
+
 export type HttpRoute<M extends Method = Method> = {
-  readonly path: string;
+  readonly path: PathString;
   readonly method: Uppercase<M>;
   readonly request: HttpRequestCodec<any>;
   readonly response: HttpResponse;

diff --git a/packages/superagent-wrapper/src/request.ts b/packages/superagent-wrapper/src/request.ts
@@ -201,7 +201,7 @@ export const requestForRoute =
     let path = route.path;
     for (const key in reqProps.params) {
       if (reqProps.params.hasOwnProperty(key)) {
-        path = path.replace(`{${key}}`, reqProps.params[key]);
+        path = path.replace(`{${key}}`, reqProps.params[key]) as h.PathString;
       }
     }