Created
September 7, 2025 13:56
-
-
Save Munawwar/4e0d6827b206f217065fc9019019614d to your computer and use it in GitHub Desktop.
Utility to narrow preact-iso route props
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
// Test this file by running: | |
// npx tsc --noEmit test/node/pattern-match.types.ts | |
export type RoutePropsForPath<Path extends string> = Path extends '*' | |
? { params: {}; rest: string } | |
: Path extends `:${infer placeholder}?/${infer rest}` | |
? { [k in placeholder]?: string } & { params: RoutePropsForPath<rest>['params'] & { [k in placeholder]?: string } } & Omit<RoutePropsForPath<rest>, 'params'> | |
: Path extends `:${infer placeholder}/${infer rest}` | |
? { [k in placeholder]: string } & { params: RoutePropsForPath<rest>['params'] & { [k in placeholder]: string } } & Omit<RoutePropsForPath<rest>, 'params'> | |
: Path extends `:${infer placeholder}?` | |
? { [k in placeholder]?: string } & { params: { [k in placeholder]?: string } } | |
: Path extends `:${infer placeholder}*` | |
? { [k in placeholder]?: string } & { params: { [k in placeholder]?: string } } | |
: Path extends `:${infer placeholder}+` | |
? { [k in placeholder]: string } & { params: { [k in placeholder]: string } } | |
: Path extends `:${infer placeholder}` | |
? { [k in placeholder]: string } & { params: { [k in placeholder]: string } } | |
: Path extends (`/${infer rest}` | `${infer _}/${infer rest}`) | |
? RoutePropsForPath<rest> | |
: { params: {} }; | |
// Test utils | |
type isEqualsType<T, U> = T extends U ? U extends T ? true : false : false; | |
type isWeakEqualsType<T, U> = T extends U ? true : false; | |
// Type tests based on router-match.test.js cases | |
// Base route test | |
const test1: isEqualsType< | |
RoutePropsForPath<'/'> , | |
{ params: {} } | |
> = true; | |
const test1_1: isEqualsType< | |
RoutePropsForPath<'/'> , | |
{ arbitrary: {} } | |
> = false; | |
// Param route test | |
const test2: isEqualsType< | |
RoutePropsForPath<'/user/:id'> , | |
{ params: { id: string }, id: string } | |
> = true; | |
const test2_weak: isWeakEqualsType< | |
RoutePropsForPath<'/user/:id'> , | |
{ params: { id: string } } | |
> = true; | |
// Param rest segment test | |
const test3: isEqualsType< | |
RoutePropsForPath<'/user/*'> , | |
{ params: {}, rest: string } | |
> = true; | |
const test3_1: isEqualsType< | |
RoutePropsForPath<'/*'> , | |
{ params: {}, rest: string } | |
> = true; | |
const test3_2: isEqualsType< | |
RoutePropsForPath<'*'> , | |
{ params: {}, rest: string } | |
> = true; | |
// Param route with rest segment test | |
const test4: isEqualsType< | |
RoutePropsForPath<'/user/:id/*'> , | |
{ params: { id: string }, id: string, rest: string } | |
> = true; | |
// Optional param route test | |
const test5: isEqualsType< | |
RoutePropsForPath<'/user/:id?'> , | |
{ params: { id?: string }, id?: string } | |
> = true; | |
// Optional rest param route "/:x*" test | |
const test6: isEqualsType< | |
RoutePropsForPath<'/user/:id*'> , | |
{ params: { id?: string }, id?: string } | |
> = true; | |
// rest param should not be present | |
const test6_error: isEqualsType< | |
RoutePropsForPath<'/user/:id*'> , | |
{ params: { id: string }, rest: string } | |
> = false; | |
// Rest param route "/:x+" test | |
const test7: isEqualsType< | |
RoutePropsForPath<'/user/:id+'> , | |
{ params: { id: string }, id: string } | |
> = true; | |
// rest param should not be present | |
const test7_error: isEqualsType< | |
RoutePropsForPath<'/user/:id+'>, | |
{ params: { id: string }, id: string, rest: string } | |
> = false; | |
// Handles leading/trailing slashes test | |
const test8: isEqualsType< | |
RoutePropsForPath<'/about-late/:seg1/:seg2/'> , | |
{ params: { seg1: string; seg2: string }, seg1: string, seg2: string } | |
> = true; | |
// Multiple params test (from overwrite properties test) | |
const test9: isEqualsType< | |
RoutePropsForPath<'/:path/:query'> , | |
{ params: { path: string; query: string }, path: string, query: string } | |
> = true; | |
// Empty route test | |
const test10: isEqualsType< | |
RoutePropsForPath<''> , | |
{ params: {} } | |
> = true; |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment