Skip to content

tsoa-next / @tsoa-next/cli / generateRoutes

Function: generateRoutes()

ts
function generateRoutes<Config>(
   routesConfig, 
   compilerOptions?, 
   ignorePaths?, 
   metadata?, 
defaultNumberType?): Promise<Metadata>;

Defined in: cli/src/module/generate-routes.ts:13

Generates route files on disk and returns the metadata used to build them.

Type Parameters

Config

Config extends ExtendedRoutesConfig

Parameters

routesConfig

Config

compilerOptions?

CompilerOptions

ignorePaths?

string[]

metadata?

Metadata

pass in cached metadata returned in a previous step to speed things up

defaultNumberType?

"double" | "float" | "integer" | "long"

Returns

Promise<Metadata>

TypeScript-first OpenAPI generation, route generation, and runtime validation.