feat: add readFormData util (#421)

Author: Hebilicious

src/utils/body.ts

@@ -134,6 +134,23 @@ export async function readMultipartFormData(event: H3Event) {
   return parseMultipartData(body, boundary);
 }
 
+/**
+ * Constructs a FormData object from an event.
+ * @param event {H3Event}
+ * @returns {FormData}
+ *
+ * ```ts
+ * const eventHandler = event => {
+ *   const formData = await readFormData(event)
+ *   const email = formData.get("email")
+ *   const password = formData.get("password")
+ *  }
+ * ```
+ */
+export async function readFormData(event: H3Event) {
+  return await event.request.formData();
+}
+
 // --- Internal ---
 
 function _parseJSON(body = "", strict: boolean) {

test/utils.test.ts

@@ -11,6 +11,7 @@ import {
   getMethod,
   getQuery,
   getRequestURL,
+  readFormData,
 } from "../src";
 
 describe("", () => {
@@ -158,4 +159,28 @@ describe("", () => {
       expect((await request.head("/post")).status).toBe(200);
     });
   });
+
+  const below18 = Number.parseInt(process.version.slice(1).split(".")[0]) < 18;
+  describe.skipIf(below18)("readFormData", () => {
+    it("can handle form as FormData in event handler", async () => {
+      app.use(
+        "/",
+        eventHandler(async (event) => {
+          const formData = await readFormData(event);
+          const user = formData.get("user");
+          expect(formData instanceof FormData).toBe(true);
+          expect(user).toBe("john");
+          return { user };
+        })
+      );
+
+      const result = await request
+        .post("/api/test")
+        .set("content-type", "application/x-www-form-urlencoded")
+        .field("user", "john");
+
+      expect(result.status).toBe(200);
+      expect(result.body).toMatchObject({ user: "john" });
+    });
+  });
 });