fix(types): correct onResponse hook response parameter type - #495
Open
koding88 wants to merge 1 commit into
Open
fix(types): correct onResponse hook response parameter type#495koding88 wants to merge 1 commit into
koding88 wants to merge 1 commit into
Conversation
There was a problem hiding this comment.
Pull request overview
This PR corrects the TypeScript types for the onResponse hook in @fastify/reply-from so the third parameter reflects the actual runtime shape ({ statusCode, headers, stream }) rather than an outgoing ServerResponse.
Changes:
- Introduces
FastifyReplyFromResponse(statusCode,headers,stream: Readable) to represent the upstream response object. - Updates
onResponsehook typing to useFastifyReplyFromResponsewhile keeping the existingRawServerResponseexport. - Updates type assertions in
types/index.tst.tsto validate the newonResponseparameter shape.
Reviewed changes
Copilot reviewed 1 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| types/index.d.ts | Adds FastifyReplyFromResponse and updates onResponse to use it. |
| types/index.tst.ts | Adjusts type assertions to validate the new onResponse response parameter shape. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+88
to
92
| expect(res).type.toBe<FastifyReplyFromResponse>() | ||
| expect(res.statusCode).type.toBe<number>() | ||
| expect(res.headers).type.toBe<Http1IncomingHttpHeaders | IncomingHttpHeaders>() | ||
| expect(res.stream).type.toBe<Readable>() | ||
| } |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #494
The
onResponsehook previously typed its third argument (res) as an outgoingServerResponseviaRawReplyDefaultExpression. At runtime, the third argument is a plain object representing the upstream incoming response payload ({ statusCode, headers, stream }).FastifyReplyFromResponsewithstatusCode,headers, andstream: Readable(matching all transports:http,undici,http2).onResponseparameter type toFastifyReplyFromResponse.RawServerResponseexport for backwards compatibility.types/index.tst.ts.