Skip to content

Support route model binding and interfaces #854

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

Merged
bakerkretzmar merged 3 commits into from
Sep 13, 2025
Merged

Support route model binding and interfaces #854

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
663e886
test: add test for route model binding and interfaces
christian98 Jul 5, 2025
f5ce45c
Support parameter objects that satisfy restrictive interfaces
bakerkretzmar Sep 13, 2025
1544bd1
Formatting
bakerkretzmar Sep 13, 2025
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 src/js/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,12 +52,15 @@ type ParameterValue = RawParameterValue | DefaultRoutable;
/**
* A parseable route parameter, either plain or nested inside an object under its binding key.
*/
type Routable<I extends ParameterInfo> = I extends { binding: string }
? ({ [K in I['binding']]: RawParameterValue } & Record<keyof any, unknown>) | RawParameterValue
type Routable<I extends ParameterInfo> = I extends { binding: infer B extends string }
?
| { [K in B]: RawParameterValue }
| ({ [K in B]: RawParameterValue } & Record<keyof any, unknown>)
| RawParameterValue
: ParameterValue;

// Uncomment to test:
// type A = Routable<{ name: 'foo', required: true, binding: 'bar' }>;
// type A = Routable<{ name: 'foo'; required: true; binding: 'bar' }>;
// = RawParameterValue | { bar: RawParameterValue }
// type B = Routable<{ name: 'foo', required: true, }>;
// = RawParameterValue | DefaultRoutable
Expand Down
8 changes: 8 additions & 0 deletions tests/js/route.test-d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,14 @@ assertType(route('posts.comments.show', { comment: { foo: 'bar' } }));
// parameter has an explicit 'uuid' binding, so that's required :)
assertType(route('posts.comments.show', { comment: { id: 2 } }));

// Interfaces
interface Model {
uuid: string;
foo: string;
}
let comment: Model = { uuid: '123', foo: 'bar' };
assertType(route('posts.comments.show', { comment, post: '1' }));

// Plain values
assertType(route('posts.comments.show', 2));
assertType(route('posts.comments.show', 'foo'));
Expand Down
Loading