تخطي إلى المحتوى

tsoa-next / @tsoa-next/cli / ExtendedRoutesConfig

Interface: ExtendedRoutesConfig

محددة في: cli/src/api.ts:416

التشويش المطّرد validateRoutesConfig.

التذييلات

  • RoutesConfig

الممتلكات

authenticationModule?

ts
optional authenticationModule?: string;

محددة في: packages/runtime/src/config.ts:274

طريق وحدة التوثيق التي تستخدمها الطرق المتولدة.

Inherited from

ts
RoutesConfig.authenticationModule

basePath?

ts
optional basePath?: string;

محددة في: packages/runtime/src/config.ts:254

"مسار الـ "بـاس أي إس أي" "مثل الـ "إف 1 https://myapi.com/v1

Inherited from

ts
RoutesConfig.basePath

bodyCoercion

ts
bodyCoercion: boolean;

محددة في: cli/src/api.ts:419

ما إذا كان يجبر ضمناً بارامترات الجسم إلى نوع مقبول

Default

ts
true

تجاوزات

ts
RoutesConfig.bodyCoercion

controllerPathGlobs?

ts
optional controllerPathGlobs?: string[];

محددة في: cli/src/api.ts:420


entryFile

ts
entryFile: string;

محددة في: cli/src/api.ts:417


esm?

ts
optional esm?: boolean;

محددة في: packages/runtime/src/config.ts:281

عند التمكين، تولد الواردات من الطرق .js تمديدات لنواتج الإدارة السليمة بيئياً.

Default

ts
false

Inherited from

ts
RoutesConfig.esm

iocModule?

ts
optional iocModule?: string;

محددة في: packages/runtime/src/config.ts:269

IoC module path, for example ./inversify/ioc.

Inherited from

ts
RoutesConfig.iocModule

middleware?

ts
optional middleware?: "express" | "hapi" | "koa";

محددة في: packages/runtime/src/config.ts:259

مُقدّم مُقدّم للبرمجة.

Inherited from

ts
RoutesConfig.middleware

middlewareTemplate?

ts
optional middlewareTemplate?: string;

محددة في: packages/runtime/src/config.ts:264

العرف Handlebars ممر نموذجي يستخدم بدلاً من نموذج البرمجيات المتوسطة

Inherited from

ts
RoutesConfig.middlewareTemplate

multerOpts?

ts
optional multerOpts?: Options;

محددة في: cli/src/api.ts:421


noImplicitAdditionalProperties

ts
noImplicitAdditionalProperties: "ignore" | "throw-on-extras" | "silently-remove-extras";

محددة في: cli/src/api.ts:418


noWriteIfUnchanged?

ts
optional noWriteIfUnchanged?: boolean;

محددة في: packages/runtime/src/config.ts:249

يكتبون ملف الطريق عندما يطابق المحتوى المولد الملف الحالي

Inherited from

ts
RoutesConfig.noWriteIfUnchanged

rewriteRelativeImportExtensions?

ts
optional rewriteRelativeImportExtensions?: boolean;

محددة في: packages/runtime/src/config.ts:295

عند التمكين، تولد الواردات من الطرق .ts تمديدات الدعم TypeScript 5.7 rewriteRelativeImportExtensions.

Default

ts
false

Inherited from

ts
RoutesConfig.rewriteRelativeImportExtensions

rootSecurity?

ts
optional rootSecurity?: Security[];

محددة في: cli/src/api.ts:422


routeGenerator?

ts
optional routeGenerator?: 
  | string
  | ((metadata, options) => AbstractRouteGenerator<ExtendedRoutesConfig>);

محددة في: cli/src/api.ts:424


routesDir

ts
routesDir: string;

محددة في: packages/runtime/src/config.ts:239

دليل أين توجد ملفات للطرق

Inherited from

ts
RoutesConfig.routesDir

routesFileName?

ts
optional routesFileName?: string;

محددة في: packages/runtime/src/config.ts:244

اسم ملف لنموذج الطريق المولد

Inherited from

ts
RoutesConfig.routesFileName

runtimeSpecConfig?

ts
optional runtimeSpecConfig?: RuntimeSpecConfigSnapshot;

محددة في: cli/src/api.ts:423

Contributors

No contributors

Changelog

No recent changes

توليد OpenAPI وتوليد المسارات والتحقق وقت التشغيل مع اعتماد TypeScript أولاً.