docs: give example of usage of defineWrappedResponseHandler

[hecktarzuli]

Added usage example for defineWrappedResponseHandler.

🔗 Linked issue

📚 Description

[bolt-new-by-stackblitz]

Run & review this pull request in StackBlitz Codeflow.

[coderabbitai]

Walkthrough

The change updates documentation in docs/2.directory-structure/1.server.md by adding an example usage of the defineWrappedResponseHandler helper, showing how to export a default wrapped handler. No source logic, exported signatures, or public APIs were modified; the change is limited to an added code snippet in the existing example.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description check	✅ Passed	The description is directly related to the changeset, stating that a usage example for defineWrappedResponseHandler was added to the documentation.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check	✅ Passed	The pull request title accurately reflects the main change: adding a usage example for defineWrappedResponseHandler to the documentation.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

docs/2.directory-structure/1.server.md (1)

131-133: Clearer documentation of response transformation.

The usage example effectively demonstrates how to apply defineWrappedResponseHandler, but it may not be immediately obvious to readers that the returned string 'hello world' will be transformed into { response: 'hello world' } by the wrapper. Consider adding a clarifying comment to help users understand this behaviour.

🔎 Suggested enhancement for clarity

~
~// usage
~export default defineWrappedResponseHandler((event) => 'hello world')
+
+// usage
+// Note: The handler's return value will be wrapped in { response: ... } by defineWrappedResponseHandler
+export default defineWrappedResponseHandler((event) => 'hello world')

Alternatively, provide a brief note after the code block explaining the transformation:

 })

+::note
+The defineWrappedResponseHandler utility wraps successful responses in a { response: ... } object and caught errors in a { err: ... } object, transforming the original handler's return value.
+::

Server Alias

</details>

</blockquote></details>

</blockquote></details>

<details>
<summary>📜 Review details</summary>

**Configuration used**: Repository UI

**Review profile**: CHILL

**Plan**: Pro

<details>
<summary>📥 Commits</summary>

Reviewing files that changed from the base of the PR and between 5d9749893c509dc4291b0b134a64784459a0b9cf and 93f2224c8b1a4f07b9103cec05b48c6defff8fc0.

</details>

<details>
<summary>📒 Files selected for processing (1)</summary>

* `docs/2.directory-structure/1.server.md`

</details>

</details>

<!-- This is an auto-generated comment by CodeRabbit for review status -->

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

docs/2.directory-structure/1.server.md (1)

131-134: Separate the usage example into its own code block with proper labelling.

The added usage example (lines 132–133) is mixed with the utility definition using an inline comment rather than a distinct, properly-labelled code block. This violates the established documentation pattern throughout the file. Additionally, the file path comment uses .js whilst the Nuxt documentation convention is to use .ts consistently.

Refactor to separate the definition and usage into distinct code blocks following the pattern used elsewhere in the documentation (e.g., lines 54–56, 76–80).

🔎 Proposed refactoring

Close the first code block after the function definition and open a separate code block for the usage example:

 ```ts [server/utils/handler.ts]
 import type { EventHandler, EventHandlerRequest } from 'h3'
 
 export const defineWrappedResponseHandler = <T extends EventHandlerRequest, D> (
   handler: EventHandler<T, D>,
 ): EventHandler<T, D> =>
   defineEventHandler<T>(async (event) => {
     try {
       // do something before the route handler
       const response = await handler(event)
       // do something after the route handler
       return { response }
     } catch (err) {
       // Error handling
       return { err }
     }
   })
-~
-~// server/api/hello.get.js
-~export default defineWrappedResponseHandler((event) => 'hello world')

+ts [server/api/hello.get.ts] +export default defineWrappedResponseHandler((event) => 'hello world') +

</details>

</blockquote></details>

</blockquote></details>

<details>
<summary>📜 Review details</summary>

**Configuration used**: Repository UI

**Review profile**: CHILL

**Plan**: Pro

<details>
<summary>📥 Commits</summary>

Reviewing files that changed from the base of the PR and between 93f2224c8b1a4f07b9103cec05b48c6defff8fc0 and 2d00c952f1663a73d3a115070cd408d7f4bc140c.

</details>

<details>
<summary>📒 Files selected for processing (1)</summary>

* `docs/2.directory-structure/1.server.md`

</details>

</details>

<!-- This is an auto-generated comment by CodeRabbit for review status -->

[danielroe]

thank you!