fix: allow returning Response objects from function Handlers
#459
Conversation
This file contains 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
Per the [functions documentation][1], it seems like you should be able to return a standard `Response` object from function handlers. However, the existing types only allows a user to return a `HandlerResponse` object. This updates the Handler type to accept both types as a return value. (It looks like netlify#351 also addresses this issue, but that PR is a little stale at this point.) [1]: https://docs.netlify.com/functions/get-started/?fn-language=ts#synchronous-function
|
Hey Nathan, appreciate the PR! The |
Skn0tt
reviewed
Jan 19, 2024
| @@ -18,7 +18,7 @@ export interface BackgroundHandler<C extends HandlerContext = HandlerContext> { | |||
| (event: HandlerEvent, context: C): void | Promise<void> | |||
| } | |||
|
|
|||
| export type Handler = BaseHandler<HandlerResponse, HandlerContext> | |||
| export type Handler = BaseHandler<HandlerResponse | Response, HandlerContext> | |||
There was a problem hiding this comment.
Maybe we could add a docs comment like this one instead?
Suggested change
| export type Handler = BaseHandler<HandlerResponse | Response, HandlerContext> | |
| /* For Lambda Compatiblity Mode */ | |
| export type Handler = BaseHandler<HandlerResponse | Response, HandlerContext> |
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.
Which problem is this pull request solving?
Per the functions documentation, it seems like you should be able to return a standard
Responseobject from function handlers. However, the existing types only allows a user to return aHandlerResponseobject.List other issues or pull requests related to this problem
It looks like #351 also addresses this issue, but that PR is a little stale at this point.
Describe the solution you've chosen
This updates the
Handlertype to accept bothHandlerResponseandResponseas a return value.Checklist
Please add a
xinside each checkbox: