tsoa-next
    Preparing search index...

    Interface Config

    interface Config {
        compilerOptions?: Record<string, unknown>;
        controllerPathGlobs?: string[];
        defaultNumberType?: "long" | "integer" | "float" | "double";
        entryFile: string;
        ignore?: string[];
        multerOpts?: Options;
        noImplicitAdditionalProperties?:
            | "ignore"
            | "throw-on-extras"
            | "silently-remove-extras";
        routes: RoutesConfig;
        spec: SpecConfig;
        tsconfig?: string;
    }
    Index

    Properties

    compilerOptions? controllerPathGlobs? defaultNumberType? entryFile ignore? multerOpts? noImplicitAdditionalProperties? routes spec tsconfig?

    Properties

    compilerOptions?: Record<string, unknown>

    TypeScript CompilerOptions to be used during generation. These are merged over compiler options resolved from tsconfig.

    RoutesConfig

    controllerPathGlobs?: string[]

    An array of path globs that point to your route controllers that you would like to have tsoa include.

    defaultNumberType?: "long" | "integer" | "float" | "double"
    entryFile: string

    The entry point to your API

    ignore?: string[]

    Directories to ignore during TypeScript metadata scan

    multerOpts?: Options

    Multer's options to generate multer's middleware. It doesn't support storage option

    {
       *   "dest": "/tmp"
       * } Allow multer to write to file instead of using Memory's buffer

    since v6.4.0 instroduces RegisterRoutes can pass multerOptions, we will quickly remove this options soon at future version. (https://github.com/lukeautry/tsoa/issues/1587#issuecomment-2391291433) (https://github.com/lukeautry/tsoa/pull/1638)

    noImplicitAdditionalProperties?:
        | "ignore"
        | "throw-on-extras"
        | "silently-remove-extras"

    Modes that allow you to prevent input data from entering into your API. This will document your decision in the swagger.yaml and it will turn on excess-property validation (at runtime) in your routes.

    routes: RoutesConfig

    Route generation configuration object

    spec: SpecConfig

    Swagger generation configuration object

    tsconfig?: string

    Path to a tsconfig file used as an input source for compiler options during generation. If omitted, tsoa-next will look for tsconfig.json starting from the loaded tsoa config directory. Explicit compilerOptions in tsoa-next config still take precedence over tsconfig values.

    Settings

    Member Visibility

    On This Page

    Properties