docs: fix typos (#919)

* docs: Update 1.request.md

Typos

* chore: apply automated updates

* docs: fix typos

* chore: apply automated updates

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>

Author: danielrentz

docs/1.guide/2.event-handler.md

@@ -222,7 +222,7 @@ You can define as much middleware as you need. They will be called in order of r
 ## Converting to h3 handler
 
 There are situations that you might want to convert an event handler or utility made for Node.js or another framework to h3.
-There are built-in utils to do this.!
+There are built-in utils to do this.
 
 ### Converting from Node.js handlers
 

docs/2.utils/1.request.md

@@ -53,7 +53,7 @@ export default defineEventHandler((event) => {
 
 ### `getQuery(event)`
 
-Get query the params object from the request URL parsed with [unjs/ufo](https://ufo.unjs.io).
+Get the query params object from the request URL parsed with [unjs/ufo](https://ufo.unjs.io).
 
 **Example:**
 
@@ -105,11 +105,13 @@ export default defineEventHandler((event) => {
 });
 ```
 
-### `getRequestIP(event)`
+### `getRequestIP(event, opts: { xForwardedFor? })`
 
 Try to get the client IP address from the incoming request.
 
-If `xForwardedFor` is `true`, it will use the `x-forwarded-for` header if it exists.
+If `xForwardedFor` is `true`, it will use the `x-forwarded-for` header set by proxies if it exists.
+
+Note: Make sure that this header can be trusted (your application running behind a CDN or reverse proxy) before enabling.
 
 If IP cannot be determined, it will default to `undefined`.
 
@@ -139,7 +141,7 @@ export default defineEventHandler((event) => {
 
 ### `getRequestURL(event, opts: { xForwardedHost?, xForwardedProto? })`
 
-Generated the full incoming request URL using `getRequestProtocol`, `getRequestHost` and `event.path`.
+Generate the full incoming request URL using `getRequestProtocol`, `getRequestHost` and `event.path`.
 
 If `xForwardedHost` is `true`, it will use the `x-forwarded-host` header if it exists.
 
@@ -183,7 +185,7 @@ export default defineEventHandler((event) => {
 
 ### `getValidatedQuery(event, validate)`
 
-Get the query param from the request URL parsed with [unjs/ufo](https://ufo.unjs.io) and validated with validate function.
+Get the query params object from the request URL parsed with [unjs/ufo](https://ufo.unjs.io) and validated with validate function.
 
 You can use a simple function to validate the query object or a library like `zod` to define a schema.
 
@@ -315,7 +317,7 @@ export default defineEventHandler(async (event) => {
 
 ### `readMultipartFormData(event)`
 
-Tries to read and parse the body of a an H3Event as multipart form.
+Tries to read and parse the body of an H3Event as multipart form.
 
 **Example:**
 

docs/2.utils/2.response.md

@@ -80,7 +80,7 @@ Set the response status code and message.
 
 ### `getResponseHeader(event, name)`
 
-Alias for `getResponseHeaders`.
+Get a response header by name.
 
 **Example:**
 
@@ -130,7 +130,7 @@ export default defineEventHandler((event) => {
 
 ### `isStream(data)`
 
-Checks if the data is a stream. (Node.js Readable Stream, React Pipeable Stream, or Web Stream)
+Checks if the data is a stream (Node.js Readable Stream, React Pipeable Stream, or Web Stream).
 
 ### `isWebResponse(data)`
 
@@ -187,7 +187,7 @@ async function delay(ms) {
 
 ### `sendNoContent(event, code?)`
 
-Respond with an empty payload.<br>
+Respond with an empty payload.
 
 Note that calling this function will close the connection and no other data can be sent to the client afterwards.
 

docs/2.utils/98.advanced.md

@@ -50,7 +50,7 @@ Get a cookie value by name.
 
 ### `parseCookies(event)`
 
-Parse the request to get HTTP Cookie header string and returning an object of all cookie name-value pairs.
+Parse the request to get HTTP Cookie header string and return an object of all cookie name-value pairs.
 
 ### `setCookie(event, name, value, serializeOptions?)`
 

src/utils/body.ts

@@ -219,7 +219,7 @@ export async function readValidatedBody<
 }
 
 /**
- * Tries to read and parse the body of a an H3Event as multipart form.
+ * Tries to read and parse the body of an H3Event as multipart form.
  *
  * @example
  * export default defineEventHandler(async (event) => {

src/utils/cookie.ts

@@ -4,7 +4,7 @@ import type { CookieSerializeOptions } from "cookie-es";
 import type { H3Event } from "../event";
 
 /**
- * Parse the request to get HTTP Cookie header string and returning an object of all cookie name-value pairs.
+ * Parse the request to get HTTP Cookie header string and return an object of all cookie name-value pairs.
  * @param event {H3Event} H3 event or req passed by h3 handler
  * @returns Object of cookie name-value pairs
  * ```ts

src/utils/request.ts

@@ -11,7 +11,7 @@ import { validateData, ValidateFunction } from "./internal/validate";
 import { getRequestWebStream } from "./body";
 
 /**
- * Get query the params object from the request URL parsed with [unjs/ufo](https://ufo.unjs.io).
+ * Get the query params object from the request URL parsed with [unjs/ufo](https://ufo.unjs.io).
  *
  * @example
  * export default defineEventHandler((event) => {
@@ -27,7 +27,7 @@ export function getQuery<
 }
 
 /**
- * Get the query param from the request URL parsed with [unjs/ufo](https://ufo.unjs.io) and validated with validate function.
+ * Get the query params object from the request URL parsed with [unjs/ufo](https://ufo.unjs.io) and validated with validate function.
  *
  * You can use a simple function to validate the query object or a library like `zod` to define a schema.
  *
@@ -319,7 +319,7 @@ export function getRequestPath(event: H3Event): string {
 }
 
 /**
- * Generated the full incoming request URL using `getRequestProtocol`, `getRequestHost` and `event.path`.
+ * Generate the full incoming request URL using `getRequestProtocol`, `getRequestHost` and `event.path`.
  *
  * If `xForwardedHost` is `true`, it will use the `x-forwarded-host` header if it exists.
  *
@@ -364,7 +364,9 @@ export function toWebRequest(event: H3Event) {
 /**
  * Try to get the client IP address from the incoming request.
  *
- * If `xForwardedFor` is `true`, it will use the `x-forwarded-for` header if it exists.
+ * If `xForwardedFor` is `true`, it will use the `x-forwarded-for` header set by proxies if it exists.
+ *
+ * Note: Make sure that this header can be trusted (your application running behind a CDN or reverse proxy) before enabling.
  *
  * If IP cannot be determined, it will default to `undefined`.
  *
@@ -375,14 +377,7 @@ export function toWebRequest(event: H3Event) {
  */
 export function getRequestIP(
   event: H3Event,
-  opts: {
-    /**
-     * Use the X-Forwarded-For HTTP header set by proxies.
-     *
-     * Note: Make sure that this header can be trusted (your application running behind a CDN or reverse proxy) before enabling.
-     */
-    xForwardedFor?: boolean;
-  } = {},
+  opts: { xForwardedFor?: boolean } = {},
 ): string | undefined {
   if (event.context.clientAddress) {
     return event.context.clientAddress;

src/utils/response.ts

@@ -46,7 +46,7 @@ export function send(
 }
 
 /**
- * Respond with an empty payload.<br>
+ * Respond with an empty payload.
  *
  * Note that calling this function will close the connection and no other data can be sent to the client afterwards.
  *
@@ -193,7 +193,7 @@ export function getResponseHeaders(
 }
 
 /**
- * Alias for `getResponseHeaders`.
+ * Get a response header by name.
  *
  * @example
  * export default defineEventHandler((event) => {
@@ -355,7 +355,7 @@ export function removeResponseHeader(
 }
 
 /**
- * Checks if the data is a stream. (Node.js Readable Stream, React Pipeable Stream, or Web Stream)
+ * Checks if the data is a stream (Node.js Readable Stream, React Pipeable Stream, or Web Stream).
  */
 export function isStream(data: any): data is Readable | ReadableStream {
   if (!data || typeof data !== "object") {

src/utils/session.ts

@@ -43,7 +43,6 @@ const DEFAULT_COOKIE: SessionConfig["cookie"] = {
 
 /**
  * Create a session manager for the current request.
- *
  */
 export async function useSession<T extends SessionDataT = SessionDataT>(
   event: H3Event,