Deprecate simple objects from endpoints #8132
Conversation
🦋 Changeset detectedLatest commit: 81a7056 The changes in this PR will be included in the next version bump. Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
github-actions
bot
added
the
pkg: astro
| export type EndpointOutput = | ||
| | { | ||
| body: Body; | ||
| encoding?: Exclude<BufferEncoding, 'binary'>; | ||
| encoding?: BufferEncoding; | ||
| } | ||
| | { | ||
| body: Uint8Array; |
There was a problem hiding this comment.
I think this was a mistake in #8003, we technically only support binary strings, and not binary unit8arrays. We have a test for binary strings and the PR caused a type error.
But simple objects are being deprecated anyways so I don't think it's a big deal.
| type: 'simple', | ||
| cookies: context.cookies, | ||
| }; | ||
| let body: BodyInit; |
There was a problem hiding this comment.
All the pipeline simple object handling converges into this function starting from this line. This should also make the dev/prod behaviour more consistent.
There was a problem hiding this comment.
Looks great, @bluwy !
As for the rest of docs, when you file an issue for this, please add a note there to remind us (inclusive! anyone can jump in here!) to do a "find all" instances of "Response" in the docs, then examine the surrounding context and update any text descriptions or code samples as needed! 🙌
Changes
callEndpoint. This makes the#endpointHandlerconvention in Pipeline not used much (onlyssrPipelinehas a special case) cc @ematipicoTesting
Added test for
ResponseWithEncoding, and tests for previous object form so they still work, until they're removed.Docs
Added changeset. Any mention of the object form in docs might need to be removed.
/cc @withastro/maintainers-docs for feedback!