From 27c11884b42c972ab6c00d869eb9499fd07a4788 Mon Sep 17 00:00:00 2001 From: Tobias Diez Date: Mon, 5 Sep 2022 09:33:07 +0200 Subject: [PATCH] docs: extend description of server handlers (#7187) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Damian Głowala <48835293+DamianGlowala@users.noreply.github.com> --- packages/schema/src/config/nitro.ts | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/packages/schema/src/config/nitro.ts b/packages/schema/src/config/nitro.ts index 091bee65ae..dde1494445 100644 --- a/packages/schema/src/config/nitro.ts +++ b/packages/schema/src/config/nitro.ts @@ -15,9 +15,23 @@ export default defineUntypedSchema({ /** * Nitro server handlers. * - * @see https://nitro.unjs.io/guide/introduction/routing + * Each handler accepts the following options: + * - handler: The path to the file defining the handler. + * - route: The route under which the handler is available. This follows the conventions of https://github.com/unjs/radix3. + * - method: The HTTP method of requests that should be handled. + * - middleware: Specifies whether it is a middleware handler. + * - lazy: Specifies whether to use lazy loading to import the handler. * - * **Note:** Files from `server/api`, `server/middleware` and `server/routes` will be automatically registred by Nuxt. + * @see https://v3.nuxtjs.org/guide/features/server-routes + * + * @note Files from `server/api`, `server/middleware` and `server/routes` will be automatically registered by Nuxt. + * + * @example + * ```js + * serverHandlers: [ + * { route: '/path/foo/**:name', handler: '~/server/foohandler.ts' } + * ] + * ``` * * @type {typeof import('nitropack')['NitroEventHandler'][]} * @version 3