Skip to content

Enhance route.lazy return type #10634

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 30, 2023
Merged

Enhance route.lazy return type #10634

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6b0e110
Enahnce route.lazy return type
brophdawg11 Jun 23, 2023
5a4df4c
Fix upstream type in RR
brophdawg11 Jun 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/route-lazy-type.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@remix-run/router": patch
---

Enhance the return type of `Route.lazy` to prohibit returning an empty object
5 changes: 2 additions & 3 deletions packages/react-router/lib/context.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ import type {
StaticHandlerContext,
To,
TrackedPromise,
LazyRouteFunction,
} from "@remix-run/router";
import type { Action as NavigationType } from "@remix-run/router";

Expand All @@ -31,7 +30,7 @@ export interface IndexRouteObject {
errorElement?: React.ReactNode | null;
Component?: React.ComponentType | null;
ErrorBoundary?: React.ComponentType | null;
lazy?: LazyRouteFunction<IndexRouteObject>;
lazy?: AgnosticIndexRouteObject["lazy"];
}

export interface NonIndexRouteObject {
Expand All @@ -49,7 +48,7 @@ export interface NonIndexRouteObject {
errorElement?: React.ReactNode | null;
Component?: React.ComponentType | null;
ErrorBoundary?: React.ComponentType | null;
lazy?: LazyRouteFunction<NonIndexRouteObject>;
lazy?: AgnosticNonIndexRouteObject["lazy"];
}

export type RouteObject = IndexRouteObject | NonIndexRouteObject;
Expand Down
9 changes: 8 additions & 1 deletion packages/router/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,12 +239,19 @@ export const immutableRouteKeys = new Set<ImmutableRouteKey>([
"children",
]);

type RequireOne<T, Key = keyof T> = Exclude<
{
[K in keyof T]: K extends Key ? Omit<T, K> & Required<Pick<T, K>> : never;
}[keyof T],
undefined
>;

/**
* lazy() function to load a route definition, which can add non-matching
* related properties to a route
*/
export interface LazyRouteFunction<R extends AgnosticRouteObject> {
(): Promise<Omit<R, ImmutableRouteKey>>;
(): Promise<RequireOne<Omit<R, ImmutableRouteKey>>>;
}

/**
Expand Down