Skip to content
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

add loader inference #122

Merged
merged 3 commits into from
Jul 14, 2022
Merged

add loader inference #122

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
77fe72d
add loader inference
kentcdodds Jul 14, 2022
68f7253
no more loaderfunction
kentcdodds Jul 14, 2022
a0336ef
inference!
kentcdodds Jul 14, 2022
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
6 changes: 1 addition & 5 deletions app/root.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,8 @@ export const meta: MetaFunction = () => ({
viewport: "width=device-width,initial-scale=1",
});

type LoaderData = {
user: Awaited<ReturnType<typeof getUser>>;
};

export const loader: LoaderFunction = async ({ request }) => {
return json<LoaderData>({
return json({
user: await getUser(request),
});
};
Expand Down
8 changes: 2 additions & 6 deletions app/routes/notes.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,14 @@ import { requireUserId } from "~/session.server";
import { useUser } from "~/utils";
import { getNoteListItems } from "~/models/note.server";

type LoaderData = {
noteListItems: Awaited<ReturnType<typeof getNoteListItems>>;
};

export const loader: LoaderFunction = async ({ request }) => {
Copy link

@penspinner penspinner Jul 14, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
export const loader: LoaderFunction = async ({ request }) => {
export const loader = async ({ request }: LoaderArgs) => {

What happens if you remove LoaderFunction?

Copy link
Contributor

@mcansh mcansh Jul 14, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yup, need to type the args and not the full function as LoaderFunction returns Promise<Response> | Response | Promise<AppData> | AppData where AppData is actually just any

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yikes. I don't remember agreeing to that. How do we avoid that?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FWIW, it does work. But is there any way we can avoid having to type the args? I'd much rather type the whole function and get type safety on what's returned as well as the args.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Though I could be convinced. I just don't remember signing up for this so I need to process it a bit...

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I hate the fact that we need to type args instead of the whole function, but I like the type inference so it's a hard one for me 😕

Copy link
Contributor

@chaance chaance Jul 14, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed, but I think the choice here was constrained by this being a breaking change if we changed the LoaderFunction/ActionFunction types. Seems like something we'll have to reconsider for v2.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, after looking at it more, I realize that it's required for TypeScript to infer the return type. My mistake. Fixing now.

Copy link

@pcattori pcattori Jul 14, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If/when the satisfies operator makes it into Typescript, we'll get the best of both worlds:

// syntax for `satisfies` TBD
const loader: satisfies LoaderFunction = () => { // TS will error if `loader` doesn't conform to `LoaderFunction`
  return json({ hello: "world"}) // ... but will still infer the narrower return type here
  // ^ use `{hello: "world"} as const` if you want `"world"` literal type instead of just `string`. standard TS thing
}

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Even better: microsoft/TypeScript#38511

const userId = await requireUserId(request);
const noteListItems = await getNoteListItems({ userId });
return json<LoaderData>({ noteListItems });
return json({ noteListItems });
};

export default function NotesPage() {
const data = useLoaderData() as LoaderData;
const data = useLoaderData<typeof loader>();
const user = useUser();

return (
Expand Down
8 changes: 2 additions & 6 deletions app/routes/notes/$noteId.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,6 @@ import { deleteNote } from "~/models/note.server";
import { getNote } from "~/models/note.server";
import { requireUserId } from "~/session.server";

type LoaderData = {
note: NonNullable<Awaited<ReturnType<typeof getNote>>>;
};

export const loader: LoaderFunction = async ({ request, params }) => {
const userId = await requireUserId(request);
invariant(params.noteId, "noteId not found");
Expand All @@ -19,7 +15,7 @@ export const loader: LoaderFunction = async ({ request, params }) => {
if (!note) {
throw new Response("Not Found", { status: 404 });
}
return json<LoaderData>({ note });
return json({ note });
};

export const action: ActionFunction = async ({ request, params }) => {
Expand All @@ -32,7 +28,7 @@ export const action: ActionFunction = async ({ request, params }) => {
};

export default function NoteDetailsPage() {
const data = useLoaderData() as LoaderData;
const data = useLoaderData<typeof loader>();

return (
<div>
Expand Down
8 changes: 4 additions & 4 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,10 @@
"@testing-library/dom": "^8.16.0",
"@testing-library/jest-dom": "^5.16.4",
"@testing-library/react": "^13.3.0",
"@testing-library/user-event": "^14.2.1",
"@testing-library/user-event": "^14.2.3",
"@types/bcryptjs": "^2.4.2",
"@types/eslint": "^8.4.5",
"@types/node": "^18.0.3",
"@types/node": "^18.0.4",
"@types/react": "^18.0.15",
"@types/react-dom": "^18.0.6",
"@vitejs/plugin-react": "^2.0.0",
Expand All @@ -63,15 +63,15 @@
"eslint": "^8.19.0",
"eslint-config-prettier": "^8.5.0",
"happy-dom": "^6.0.3",
"msw": "^0.44.0",
"msw": "^0.44.1",
"npm-run-all": "^4.1.5",
"postcss": "^8.4.14",
"prettier": "2.7.1",
"prettier-plugin-tailwindcss": "^0.1.12",
"prisma": "^4.0.0",
"start-server-and-test": "^1.14.0",
"tailwindcss": "^3.1.6",
"ts-node": "^10.8.2",
"ts-node": "^10.9.1",
"tsconfig-paths": "^4.0.0",
"typescript": "^4.7.4",
"vite": "^3.0.0",
Expand Down