feat: export PathParam type

remix-run · Oct 3, 2023 · c2d5c0e · c2d5c0e
1 parent f77743a
commit c2d5c0e
Show file tree

Hide file tree

Showing 7 changed files with 16 additions and 1 deletion.
diff --git a/.changeset/cyan-knives-shake.md b/.changeset/cyan-knives-shake.md
@@ -0,0 +1,9 @@
+---
+"react-router-dom-v5-compat": minor
+"react-router-native": minor
+"react-router-dom": minor
+"react-router": minor
+"@remix-run/router": minor
+---
+
+Export the `PathParam` type from the public API
diff --git a/packages/react-router-dom-v5-compat/index.ts b/packages/react-router-dom-v5-compat/index.ts
@@ -85,6 +85,7 @@ export type {
   Params,
   Path,
   PathMatch,
+  PathParam,
   PathPattern,
   PathRouteProps,
   Pathname,

diff --git a/packages/react-router-dom/index.tsx b/packages/react-router-dom/index.tsx
@@ -116,6 +116,7 @@ export type {
   Path,
   PathMatch,
   Pathname,
+  PathParam,
   PathPattern,
   PathRouteProps,
   RedirectFunction,

diff --git a/packages/react-router-native/index.tsx b/packages/react-router-native/index.tsx
@@ -51,6 +51,7 @@ export type {
   Path,
   PathMatch,
   Pathname,
+  PathParam,
   PathPattern,
   PathRouteProps,
   RedirectFunction,

diff --git a/packages/react-router/index.ts b/packages/react-router/index.ts
@@ -18,6 +18,7 @@ import type {
   Params,
   Path,
   PathMatch,
+  PathParam,
   PathPattern,
   RedirectFunction,
   RelativeRoutingType,
@@ -153,6 +154,7 @@ export type {
   Params,
   Path,
   PathMatch,
+  PathParam,
   PathPattern,
   PathRouteProps,
   Pathname,

diff --git a/packages/router/index.ts b/packages/router/index.ts
@@ -20,6 +20,7 @@ export type {
   ParamParseKey,
   Params,
   PathMatch,
+  PathParam,
   PathPattern,
   RedirectFunction,
   ShouldRevalidateFunction,

diff --git a/packages/router/utils.ts b/packages/router/utils.ts
@@ -349,7 +349,7 @@ type _PathParam<Path extends string> =
  * "/:a/:b" -> "a" | "b"
  * "/:a/b/:c/*" -> "a" | "c" | "*"
  */
-type PathParam<Path extends string> =
+export type PathParam<Path extends string> =
   // check if path is just a wildcard
   Path extends "*" | "/*"
     ? "*"