generateUrls

types/universal-router/generateUrls.d.ts

@@ -0,0 +1,14 @@
+import UniversalRouter, { Params } from ".";
+
+export interface generateUrlsOptions {
+    /**
+     * Provide a function to stringifyQueryParams option to generate URL with query string from unknown route params.
+     */
+    stringifyQueryParams?: (params: Params) => string;
+    [_: string]: any;
+}
+
+/**
+ * In most web applications it's much simpler to just use a string for hyperlinks.
+ */
+export default function generateUrls(router: UniversalRouter, options?: generateUrlsOptions): (routeName: string, params?: Params) => string;

types/universal-router/index.d.ts

@@ -10,7 +10,7 @@
  * Each URL parameter resolves to a string.
  */
 export interface Params {
-    [_: string]: string;
+    [_: string]: any;
 }
 
 /**

types/universal-router/tsconfig.json

@@ -20,6 +20,7 @@
     },
     "files": [
         "index.d.ts",
+        "generateUrls.d.ts",
         "universal-router-tests.ts"
     ]
-}
+}

types/universal-router/universal-router-tests.ts

@@ -1,4 +1,5 @@
 import UniversalRouter from "universal-router";
+import generateUrls from "universal-router/generateUrls";
 
 new UniversalRouter(
     {
@@ -63,3 +64,11 @@ new UniversalRouter({
         },
     ],
 });
+
+const url = generateUrls(new UniversalRouter([
+    { name: 'users', path: '/users' },
+    { name: 'user', path: '/user/:username' },
+], { baseUrl: '/base' }));
+
+url('users'); // => '/base/users'
+url('user', { username: 'john' }); // => '/base/user/john'