feat: add RouteProps type and export types from index

erictaylor · Sep 1, 2021 · 58bdb88 · 58bdb88
1 parent e0fbfef
commit 58bdb88
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/src/index.ts b/src/index.ts
@@ -15,3 +15,6 @@ export { createBrowserRouter } from './utils/createBrowserRouter';
 export { createHashRouter } from './utils/createHashRouter';
 export { createMemoryRouter } from './utils/createMemoryRouter';
 export { SuspenseResource } from './utils/SuspenseResource';
+
+// Types
+export * from './types';
diff --git a/src/types.ts b/src/types.ts
@@ -256,3 +256,22 @@ export interface PreparedRouteEntry {
   location: Path;
   props: PreparedRouteEntryProps;
 }
+
+/**
+ * This is the type your route components should extend from.
+ *
+ * @example
+ * ```
+ * import type { RouteProps } from 'yarr';
+ *
+ * export interface MyRouteComponentProps extends RouteProps<'/some/path/:id'> {
+ *   preloaded: {
+ *     query: () => Promise<{ id: string }>;
+ *   };
+ * }
+ * ```
+ */
+export interface RouteProps<Path extends string>
+  extends PreparedRouteEntryProps {
+  params: RouteParameters<Path>;
+}