Skip to content

Commit

Permalink
Soft deprecate returning a new object. See hapijs#4299 for details
Browse files Browse the repository at this point in the history
  • Loading branch information
kanongil committed Oct 11, 2021
1 parent 404d253 commit fcfe96f
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion API.md
Original file line number Diff line number Diff line change
Expand Up @@ -4819,7 +4819,7 @@ Returns a [`response`](#response-object) which you can pass into the [reply inte
- `variety` - a sting name of the response type (e.g. `'file'`).
- `prepare` - a function with the signature `async function(response)` used to prepare the response after it is returned by a [lifecycle method](#lifecycle-methods) such as setting a file descriptor, where:
- `response` - the response object being prepared.
- must return the prepared response object (new object or `response`).
- must return the prepared response object (`response`).
- may throw an error which is used as the prepared response.
- `marshal` - a function with the signature `async function(response)` used to prepare the response for transmission to the client before it is sent, where:
- `response` - the response object being marshaled.
Expand Down

0 comments on commit fcfe96f

Please sign in to comment.