feat: addsendNoContent utility to create a 204 response (#250)

* feat: add sendEmpty helper method to create a response with an empty payload * fix linter * small updates * update readme Co-authored-by: Pooya Parsa <[email protected]>
unjs · Dec 15, 2022 · 0979cac · 0979cac
1 parent 4e52381
commit 0979cac
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -148,6 +148,7 @@ H3 has concept of compasable utilities that accept `event` (from `eventHandler((
 - `createError({ statusCode, statusMessage, data? })`
 - `sendProxy(event, { target, headers?, fetchOptions?, fetch?, sendStream? })`
 - `proxyRequest(event, { target, headers?, fetchOptions?, fetch?, sendStream? })`
+- `sendNoContent(event, code = 204)`
 - `setResponseStatus(event, status)`
 - `getResponseStatus(event)`
 - `getResponseStatusText(event)`

diff --git a/src/utils/response.ts b/src/utils/response.ts
@@ -19,6 +19,22 @@ export function send(event: H3Event, data?: any, type?: string): Promise<void> {
   });
 }
 
+/**
+ * Respond with an empty payload.<br>
+ * Note that calling this function will close the connection and no other data can be sent to the client afterwards.
+ *
+ * @param event H3 event
+ * @param code status code to be send. By default, it is `204 No Content`.
+ */
+export function sendNoContent(event: H3Event, code = 204) {
+  event.node.res.statusCode = code;
+  // 204 responses MUST NOT have a Content-Length header field (https://www.rfc-editor.org/rfc/rfc7230#section-3.3.2)
+  if (event.node.res.statusCode === 204) {
+    event.node.res.removeHeader("content-length");
+  }
+  event.node.res.end();
+}
+
 export function setResponseStatus(
   event: H3Event,
   code: number,