From 54eaa5b213fb8f695e601890b4f3aed13e298a4e Mon Sep 17 00:00:00 2001 From: "autofix-ci[bot]" <114827586+autofix-ci[bot]@users.noreply.github.com> Date: Sun, 23 Jun 2024 21:48:16 +0000 Subject: [PATCH] chore: apply automated updates --- docs/2.utils/1.request.md | 26 --------------- docs/2.utils/2.response.md | 66 ------------------------------------- docs/2.utils/98.advanced.md | 2 +- 3 files changed, 1 insertion(+), 93 deletions(-) diff --git a/docs/2.utils/1.request.md b/docs/2.utils/1.request.md index 31ccab82c..88b744e63 100644 --- a/docs/2.utils/1.request.md +++ b/docs/2.utils/1.request.md @@ -25,32 +25,6 @@ export default defineEventHandler((event) => { }); ``` -### `getHeader(event, name)` - -Get a request header by name. - -**Example:** - -```ts -export default defineEventHandler((event) => { - const contentType = getRequestHeader(event, "content-type"); // "application/json" -}); -``` - -### `getHeaders(event)` - -Get the request headers object. - -Array headers are joined with a comma. - -**Example:** - -```ts -export default defineEventHandler((event) => { - const headers = getRequestHeaders(event); // { "content-type": "application/json", "x-custom-header": "value" } -}); -``` - ### `getQuery(event)` Get query the params object from the request URL parsed with [unjs/ufo](https://ufo.unjs.io). diff --git a/docs/2.utils/2.response.md b/docs/2.utils/2.response.md index b59a3ba76..50f33216d 100644 --- a/docs/2.utils/2.response.md +++ b/docs/2.utils/2.response.md @@ -8,33 +8,6 @@ icon: material-symbols-light:output -### `appendHeader(event, name, value)` - -Append a response header by name. - -**Example:** - -```ts -export default defineEventHandler((event) => { - appendResponseHeader(event, "content-type", "text/html"); -}); -``` - -### `appendHeaders(event, headers)` - -Append the response headers. - -**Example:** - -```ts -export default defineEventHandler((event) => { - appendResponseHeaders(event, { - "content-type": "text/html", - "cache-control": "no-cache", - }); -}); -``` - ### `appendResponseHeader(event, name, value)` Append a response header by name. @@ -78,18 +51,6 @@ export default defineEventHandler((event) => { Set the response status code and message. -### `getResponseHeader(event, name)` - -Alias for `getResponseHeaders`. - -**Example:** - -```ts -export default defineEventHandler((event) => { - const contentType = getResponseHeader(event, "content-type"); // Get the response content-type header -}); -``` - ### `getResponseHeaders(event)` Get the response headers object. @@ -226,33 +187,6 @@ export default defineEventHandler((event) => { Send a Web besponse object to the client. -### `setHeader(event, name, value)` - -Set a response header by name. - -**Example:** - -```ts -export default defineEventHandler((event) => { - setResponseHeader(event, "content-type", "text/html"); -}); -``` - -### `setHeaders(event, headers)` - -Set the response headers. - -**Example:** - -```ts -export default defineEventHandler((event) => { - setResponseHeaders(event, { - "content-type": "text/html", - "cache-control": "no-cache", - }); -}); -``` - ### `setResponseHeader(event, name, value)` Set a response header by name. diff --git a/docs/2.utils/98.advanced.md b/docs/2.utils/98.advanced.md index 7db3d840b..d63ddd907 100644 --- a/docs/2.utils/98.advanced.md +++ b/docs/2.utils/98.advanced.md @@ -52,7 +52,7 @@ Get a cookie value by name. Parse the request to get HTTP Cookie header string and returning an object of all cookie name-value pairs. -### `setCookie(event, name, value, serializeOptions?)` +### `setCookie(event, name, value, options?)` Set a cookie value by name.