@namecheap/tsoa-cli
Version:
Build swagger-compliant REST APIs using TypeScript and Node
26 lines (25 loc) • 1.09 kB
TypeScript
import { Config, RoutesConfig, SpecConfig, Tsoa } from '@namecheap/tsoa-runtime';
export interface ExtendedSpecConfig extends SpecConfig {
entryFile: Config['entryFile'];
noImplicitAdditionalProperties: Exclude<Config['noImplicitAdditionalProperties'], undefined>;
controllerPathGlobs?: Config['controllerPathGlobs'];
}
export declare const validateSpecConfig: (config: Config) => Promise<ExtendedSpecConfig>;
export interface ExtendedRoutesConfig extends RoutesConfig {
entryFile: Config['entryFile'];
noImplicitAdditionalProperties: Exclude<Config['noImplicitAdditionalProperties'], undefined>;
controllerPathGlobs?: Config['controllerPathGlobs'];
multerOpts?: Config['multerOpts'];
}
export interface ConfigArgs {
basePath?: string;
configuration?: string | Config;
}
export interface SwaggerArgs extends ConfigArgs {
host?: string;
json?: boolean;
yaml?: boolean;
}
export declare function runCLI(): void;
export declare function generateSpecAndRoutes(args: SwaggerArgs, metadata?: Tsoa.Metadata): Promise<Tsoa.Metadata>;