chore(warn): deprecation of config multer options (#1695)

lukeautry · Oct 5, 2024 · e10185b · e10185b
1 parent d8c881a
commit e10185b
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 2 deletions.
diff --git a/packages/cli/src/module/generate-routes.ts b/packages/cli/src/module/generate-routes.ts
@@ -5,7 +5,7 @@ import { Tsoa } from '@tsoa/runtime';
 import { DefaultRouteGenerator } from '../routeGeneration/defaultRouteGenerator';
 import { fsMkDir } from '../utils/fs';
 import path = require('path');
-import { Config as BaseConfig } from "@tsoa/runtime";
+import { Config as BaseConfig } from '@tsoa/runtime';
 
 export async function generateRoutes<Config extends ExtendedRoutesConfig>(
   routesConfig: Config,
@@ -15,7 +15,7 @@ export async function generateRoutes<Config extends ExtendedRoutesConfig>(
    * pass in cached metadata returned in a previous step to speed things up
    */
   metadata?: Tsoa.Metadata,
-  defaultNumberType?: BaseConfig['defaultNumberType']
+  defaultNumberType?: BaseConfig['defaultNumberType'],
 ) {
   if (!metadata) {
     metadata = new MetadataGenerator(routesConfig.entryFile, compilerOptions, ignorePaths, routesConfig.controllerPathGlobs, routesConfig.rootSecurity, defaultNumberType).Generate();
@@ -26,6 +26,15 @@ export async function generateRoutes<Config extends ExtendedRoutesConfig>(
   await fsMkDir(routesConfig.routesDir, { recursive: true });
   await routeGenerator.GenerateCustomRoutes();
 
+  if (routesConfig.multerOpts) {
+    console.warn(
+      'Config MulterOptions is deprecated 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)',
+    );
+  }
+
   return metadata;
 }
 

diff --git a/packages/runtime/src/config.ts b/packages/runtime/src/config.ts
@@ -47,6 +47,11 @@ export interface Config {
    * @example {
    *   "dest": "/tmp"
    * } Allow multer to write to file instead of using Memory's buffer
+   * @deprecated
+   *  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)
    */
   multerOpts?: MulterOpts;