chore: rename to eventToRequest and readFormData

README.md

@@ -206,8 +206,8 @@ H3 has a concept of composable utilities that accept `event` (from `eventHandler
 - `getRequestHost(event)`
 - `getRequestProtocol(event)`
 - `getRequestURL(event)`
-- `getRequestFromEvent(event)`
-- `getFormData(event)`
+- `eventToRequest(event)`
+- `readFormData(event)`
 
 👉 You can learn more about usage in [JSDocs Documentation](https://www.jsdocs.io/package/h3#package-functions).
 

src/utils/body.ts

@@ -2,7 +2,7 @@ import destr from "destr";
 import type { Encoding, HTTPMethod } from "../types";
 import type { H3Event } from "../event";
 import { parse as parseMultipartData } from "./internal/multipart";
-import { assertMethod, getRequestFromEvent, getRequestHeader } from "./request";
+import { assertMethod, eventToRequest, getRequestHeader } from "./request";
 
 export type { MultiPartData } from "./internal/multipart";
 
@@ -137,12 +137,12 @@ export async function readMultipartFormData(event: H3Event) {
  *
  * ```ts
  * const eventHandler = event => {
- *   const formData = await getFormData(event)
+ *   const formData = await readFormData(event)
  *   const email = formData.get("email")
  *   const password = formData.get("password")
  *  }
  * ```
  */
-export async function getFormData(event: H3Event) {
-  return (await getRequestFromEvent(event)).formData();
+export async function readFormData(event: H3Event) {
+  return (await eventToRequest(event)).formData();
 }

src/utils/request.ts

@@ -138,12 +138,12 @@ export function getRequestURL(
  *
  * ```ts
  * const eventHandler = event => {
- *   const request = await getRequestFromEvent(event)
+ *   const request = await eventToRequest(event)
  *   if(request instanceof Request) // true
  *  }
  * ```
  */
-export async function getRequestFromEvent(event: H3Event) {
+export async function eventToRequest(event: H3Event) {
   const url = new URL(getRequestURL(event));
   const body = await readRawBody(event);
   return new Request(url, {

test/utils.test.ts

@@ -11,8 +11,8 @@ import {
   getMethod,
   getQuery,
   getRequestURL,
-  getRequestFromEvent,
-  getFormData,
+  eventToRequest,
+  readFormData,
 } from "../src";
 
 describe("", () => {
@@ -162,12 +162,12 @@ describe("", () => {
   });
 
   const below18 = Number.parseInt(process.version.slice(1).split(".")[0]) < 18;
-  describe.skipIf(below18)("getRequestFromEvent", () => {
+  describe.skipIf(below18)("eventToRequest", () => {
     it("can handle request as Request in event handler", async () => {
       app.use(
         "/",
         eventHandler(async (event) => {
-          const nativeRequest = await getRequestFromEvent(event);
+          const nativeRequest = await eventToRequest(event);
           expect(nativeRequest instanceof Request).toBe(true);
           expect(nativeRequest.method).toBe("POST");
           expect(nativeRequest.headers.get("hello")).toBe("world");
@@ -192,7 +192,7 @@ describe("", () => {
       app.use(
         "/",
         eventHandler(async (event) => {
-          const formData = await getFormData(event);
+          const formData = await readFormData(event);
           const user = formData.get("user");
           expect(formData instanceof FormData).toBe(true);
           expect(user).toBe("john");