Skip to content
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

Jump to bottom

[chore] expose Body generic to hook functions #2413

Merged
merged 5 commits into from
Sep 14, 2021
Merged

[chore] expose Body generic to hook functions #2413

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ec9bf2e
Add Body generic to hooks
george-lim Sep 12, 2021
bdb69e5
Add changeset
george-lim Sep 12, 2021
960e504
Update hooks documentation
george-lim Sep 13, 2021
2e01a32
Remove MaybePromise helper type from hooks documentation
george-lim Sep 13, 2021
ca081e9
update changeset
ignatiusmb Sep 14, 2021
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
5 changes: 5 additions & 0 deletions .changeset/two-buttons-eat.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@sveltejs/kit': patch
---

Add Body generic to hooks
14 changes: 7 additions & 7 deletions packages/kit/types/hooks.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,19 @@ export interface ServerResponse {
body?: StrictBody;
}

export interface GetSession<Locals = Record<string, any>, Session = any> {
(request: ServerRequest<Locals>): MaybePromise<Session>;
export interface GetSession<Locals = Record<string, any>, Body = unknown, Session = any> {
Copy link
Member

Choose a reason for hiding this comment

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

Inserting the argument in the middle will be a breaking change, but it does make sense considering the usage order and keeps it consistent with the order from other types like Load. Let's make sure to also update the docs accordingly so users can crosscheck properly.

Copy link

Choose a reason for hiding this comment

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

Alternatively, one could use variadic tuples if BC should be kept: https://www.typescriptlang.org/docs/handbook/release-notes/typescript-4-0.html

This would result in more work and bloat in the implementation, so I would personally vote against it. Just wanted to point out that it would be possible.

Copy link
Contributor Author

@george-lim george-lim Sep 13, 2021 •
edited by benmccann
Loading

Choose a reason for hiding this comment

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

@ignatiusmb I updated the docs to reflect the changes.
@benbender I agree with you there, it's cool that it's possible but I don't think it's worth the bloat.

(request: ServerRequest<Locals, Body>): MaybePromise<Session>;
}

export interface Handle<Locals = Record<string, any>> {
export interface Handle<Locals = Record<string, any>, Body = unknown> {
(input: {
request: ServerRequest<Locals>;
resolve(request: ServerRequest<Locals>): MaybePromise<ServerResponse>;
request: ServerRequest<Locals, Body>;
resolve(request: ServerRequest<Locals, Body>): MaybePromise<ServerResponse>;
}): MaybePromise<ServerResponse>;
}

export interface HandleError<Locals = Record<string, any>> {
(input: { error: Error & { frame?: string }; request: ServerRequest<Locals> }): void;
export interface HandleError<Locals = Record<string, any>, Body = unknown> {
(input: { error: Error & { frame?: string }; request: ServerRequest<Locals, Body> }): void;
}

export interface ExternalFetch {
Expand Down