Skip to content
This repository has been archived by the owner on Apr 6, 2023. It is now read-only.

docs(guide): add nitro plugins to server directory #7780

Merged
merged 2 commits into from Sep 26, 2022
Merged

docs(guide): add nitro plugins to server directory #7780

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
846eaf3
docs(guide): add Nitro plugins to directory structure
huang-julien Sep 23, 2022
58fdb8a
docs: tweak
danielroe Sep 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
15 changes: 15 additions & 0 deletions docs/content/2.guide/2.directory-structure/1.server.md
View file
Open in desktop
Expand Up @@ -66,6 +66,21 @@ export default defineEventHandler((event) => {
})
```

## Server Plugins

Nuxt will automatically read any files in the `~/server/plugins` directory and register them as Nitro plugins. This allows extending Nitro's runtime behavior and hooking into lifecycle events.

**Example:**

```ts [server/plugins/nitroPlugin.ts]
export default defineNitroPlugin((nitroApp) => {
console.log('Nitro plugin', nitroApp)
})
```

::ReadMore{link="https://nitro.unjs.io/guide/advanced/plugins" title="Nitro Plugins"}
::

## Server Utilities

Server routes are powered by [unjs/h3](https://github.com/unjs/h3) which comes with a handy set of helpers.
Expand Down