Skip to content

Fix incorrect useQueryParam setter example in use-page-state-readability.md #704

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix incorrect useQueryParam setter example in use-page-state-readability.md #704

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 6 additions & 3 deletions fundamentals/code-quality/code/examples/use-page-state-readability.md
View file
Open in desktop
Copy link

@kss2002 kss2002 Nov 28, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

hello 👋
You changed the call _setCardId from object to primitive

// previous
_setCardId({ cardId }, "replaceIn");

// updated
_setCardId(cardId, "replaceIn");

This may change the shape of the query parameter and could affect existing behavior or consumers that expect the object form.

Can you confirm that this change is intentional and aligned with how useQueryParam + NumberParam are expected to work?

I think updating the dependency array to include _setCardId is a good improvement!

Thank you :)

Copy link
Author

@suinkimme suinkimme Nov 28, 2025

Choose a reason for hiding this comment

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

Thanks for the review and for pointing this out!

In this case, the change was intentional.
Since useQueryParam("cardId", NumberParam) is used, the setter returned by useQueryParam expects a primitive number, not an object. Passing { cardId } was causing a mismatch with how NumberParam serializes the value, and could result in an incorrect query parameter shape.

Therefore, _setCardId(cardId, "replaceIn") is the correct usage aligned with the expected behavior of useQueryParam + NumberParam.

Thanks again for the thoughtful review!

#76 (comment)

If I’m mistaken in any way, please don’t hesitate to let me know!

Copy link

@kss2002 kss2002 Nov 28, 2025

Choose a reason for hiding this comment

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

Thank you for your answer.

I wrote a review considering the influence of other documents.
I think it's a good contribution given that it's a deliberate change.

Thank you :)

Original file line number Diff line number Diff line change
Expand Up @@ -89,9 +89,12 @@ import { NumberParam, useQueryParam } from "use-query-params";
export function useCardIdQueryParam() {
const [cardId, _setCardId] = useQueryParam("cardId", NumberParam);

const setCardId = useCallback((cardId: number) => {
_setCardId({ cardId }, "replaceIn");
}, []);
const setCardId = useCallback(
(cardId: number) => {
_setCardId(cardId, "replaceIn");
},
[_setCardId]
);

return [cardId ?? undefined, setCardId] as const;
}
Expand Down