mirror of
https://github.com/nuxt/nuxt.git
synced 2024-11-15 10:24:50 +00:00
df2bad76bc
* feat(schema): add `routes` as shortcut for `nitro.routes` * docs: improve wording * docs: update wording * chore: match nitro version * update jsdocs * refactor: use `routeRules` Co-authored-by: Pooya Parsa <pooya@pi0.io>
70 lines
1.8 KiB
TypeScript
70 lines
1.8 KiB
TypeScript
import { defineUntypedSchema } from 'untyped'
|
|
|
|
export default defineUntypedSchema({
|
|
/**
|
|
* Configuration for Nitro.
|
|
*
|
|
* @see https://nitro.unjs.io/config/
|
|
*
|
|
* @type {typeof import('nitropack')['NitroConfig']}
|
|
* @version 2
|
|
* @version 3
|
|
*/
|
|
nitro: {
|
|
routes: {
|
|
$resolve: async (val, get) => ({
|
|
...await get('routeRules') || {},
|
|
...val || {}
|
|
})
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Global route options applied to matching server routes.
|
|
*
|
|
* @experimental This is an experimental feature and API may change in the future.
|
|
*
|
|
* @see https://nitro.unjs.io/config/#routes
|
|
*
|
|
* @type {typeof import('nitropack')['NitroConfig']['routes']}
|
|
* @version 3
|
|
*/
|
|
routeRules: {},
|
|
|
|
/**
|
|
* Nitro server handlers.
|
|
*
|
|
* 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.
|
|
*
|
|
* @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
|
|
*/
|
|
serverHandlers: [],
|
|
|
|
/**
|
|
* Nitro development-only server handlers.
|
|
*
|
|
* @see https://nitro.unjs.io/guide/introduction/routing
|
|
*
|
|
* @type {typeof import('nitropack')['NitroDevEventHandler'][]}
|
|
* @version 3
|
|
*/
|
|
devServerHandlers: []
|
|
})
|