Improved path query types

stackoverfloweth commented 3 weeks ago

Improved the way we capture optional params in type system.
- previously we were defining the param inside of params as StringConstructor | undefined for example. So basically if a Param has | undefined, it meant it should be optional.
- this adds the complication of having to check for missing values and is redundant since we can derive the fact that it's optional by looking for the optional symbol in the Param.
I updated the definition for ResolvedRoute so that if it's created without a generic (using the default), it will widen params to Record<string, unknown>, otherwise it would be {}.
path and query types have stronger typed defaults, when used without defaults will have Record<string, Param> for params.

netlify[bot] commented 3 weeks ago

Name	Link
Latest commit	2b64217814d8f660a356d319eb962b54182ecb81
Latest deploy log	https://app.netlify.com/sites/kitbag-router/deploys/6665a9e32b517f0008118980
Deploy Preview	https://deploy-preview-194--kitbag-router.netlify.app
Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

pleek91 commented 3 weeks ago

@stackoverfloweth seems fine. What problem are you solving here? The benefit isn't obvious to me.

stackoverfloweth commented 3 weeks ago

@stackoverfloweth seems fine. What problem are you solving here? The benefit isn't obvious to me.

@pleek91, I've updated the readme to include some additional context, hope that helps

kitbagjs / router