Skip to content

fix(react-router): preserve required params in generatePath types#14856

Open
grzdev wants to merge 3 commits intoremix-run:mainfrom
grzdev:fix/generatepath-optional-param-types
Open

fix(react-router): preserve required params in generatePath types#14856
grzdev wants to merge 3 commits intoremix-run:mainfrom
grzdev:fix/generatepath-optional-param-types

Conversation

@grzdev
Copy link

@grzdev grzdev commented Mar 6, 2026

Summary

generatePath currently types all path params as required, even when the path contains optional params like :id?.

This change distinguishes required and optional path params in the type signature so optional params can be omitted while required params remain enforced.

Changes

  • add OptionalPathParam<Path> to extract optional path params
  • add GeneratePathParams<Path> to model required and optional params separately
  • update generatePath to use GeneratePathParams<Path>
  • add type tests covering optional path params and splat behavior

Verification

  • pnpm typecheck
  • npx jest --testPathPattern generatePath

@changeset-bot
Copy link

changeset-bot bot commented Mar 6, 2026

⚠️ No Changeset found

Latest commit: 9f8582c

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@remix-cla-bot
Copy link
Contributor

remix-cla-bot bot commented Mar 6, 2026

Hi @grzdev,

Welcome, and thank you for contributing to React Router!

Before we consider your pull request, we ask that you sign our Contributor License Agreement (CLA). We require this only once.

You may review the CLA and sign it by adding your name to contributors.yml.

Once the CLA is signed, the CLA Signed label will be added to the pull request.

If you have already signed the CLA and received this response in error, or if you have any questions, please contact us at hello@remix.run.

Thanks!

- The Remix team

@remix-cla-bot
Copy link
Contributor

remix-cla-bot bot commented Mar 6, 2026

Thank you for signing the Contributor License Agreement. Let's get this merged! 🥳

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant