tsoa-next / @tsoa-next/cli / generateSpec

Function: generateSpec()

function generateSpec(
   swaggerConfig, 
   compilerOptions?, 
   ignorePaths?, 
   metadata?, 
defaultNumberType?): Promise<Metadata>;

Defined in: cli/src/module/generate-spec.ts:22

Generates an OpenAPI document on disk and returns the metadata used to build it.

Parameters

swaggerConfig

ExtendedSpecConfig

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>