Skip to content

extractSwaggerDocs

reference
1 min readUpdated

Kind: Function

Source: atloria-monorepo/libs/parser-core/src/parsers/backend/nestjs-swagger-docs.ts

Everything @nestjs/swagger decorators state about one operation.

Controller-level decorators are passed too — @ApiTags is conventionally written once on the class — and method-level values win, which is the precedence NestJS itself applies.

Signature

ts
function extractSwaggerDocs(methodDecorators: readonly ts.Decorator[], controllerDecorators: readonly ts.Decorator[]): AuthoredDocs

Parameters

NameType
methodDecoratorsreadonly ts.Decorator[]
controllerDecoratorsreadonly ts.Decorator[]

Returns: AuthoredDocs

Was this page helpful?

Download as PDF