From b7725133f867b5e530dd4bb5d1fd8d5d389e3364 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bal=C3=A1zs=20Orb=C3=A1n?= Date: Thu, 3 Feb 2022 03:41:28 +0100 Subject: [PATCH] docs: recommend `.end` instead of `.send` when no body is being sent (#33611) Fixes #33536 I was thinking to make `body` optional here instead: https://github.com/vercel/next.js/blob/2c6bd1ed1b3821debda74dc8f407b8f11779a4f0/packages/next/shared/lib/utils.ts#L262 But that might result in more errors when not setting the status code correctly. So it's the easiest for us to just recommend `.end()` which `.send()` uses when there is no argument. https://github.com/vercel/next.js/blob/c71465d87a7eeb050e5cc7e94817f19e69e9d1e4/packages/next/server/api-utils.ts#L269 ## Bug - [ ] Related issues linked using `fixes #number` - [ ] Integration tests added - [ ] Errors have helpful link attached, see `contributing.md` ## Feature - [ ] Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR. - [ ] Related issues linked using `fixes #number` - [ ] Integration tests added - [ ] Documentation added - [ ] Telemetry added. In case of a feature if it's used or not. - [ ] Errors have helpful link attached, see `contributing.md` ## Documentation / Examples - [ ] Make sure the linting passes by running `yarn lint` --- errors/invalid-api-status-body.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/errors/invalid-api-status-body.md b/errors/invalid-api-status-body.md index b0d5fd60fd..0c3a7b0ab0 100644 --- a/errors/invalid-api-status-body.md +++ b/errors/invalid-api-status-body.md @@ -22,7 +22,7 @@ After ```js export default function handler(req, res) { - res.status(204).send() + res.status(204).end() } ```