Skip to main content

Server Options

The Burger constructor accepts a ServerOptions object. These are the main options:

OptionTypeDescription
apiDirstringDirectory containing API route files (e.g. route.ts). Required unless apiRoutes is set.
apiRoutesRouteDefinition[]Pre-built API routes for production; when set, apiDir is ignored.
pageDirstringDirectory for static/dynamic page files. Optional unless you serve pages.
pageRoutesPageDefinition[]Pre-built page routes for production; when set, pageDir is ignored.
apiPrefixstringURL prefix for API routes (default: 'api').
pagePrefixstringURL prefix for page routes (default: '').
globalMiddlewareMiddleware[]Middleware that runs on every request.
titlestringAPI title for OpenAPI docs.
descriptionstringAPI description for OpenAPI.
versionstringAPI version for OpenAPI.
debugbooleanEnable debug mode (e.g. stack traces).

You must provide either apiDir/pageDir (for development) or apiRoutes/pageRoutes (for production builds). See Configuration for full details and examples.