@WithDocs()

コンパニオンファイル検出の対象としてコントローラーをマークするクラスデコレーターです。@Controller()と組み合わせて使います。

使い方

ts
@WithDocs()
@Controller('products')
export class ProductsController { ... }

DOCFY_MARKER

また、クラスにDOCFY_MARKERメタデータを設定するため、外部からのイントロスペクションでも利用できます。

ts
import { DOCFY_MARKER } from "nestjs-docfy";

Reflect.getMetadata(DOCFY_MARKER, ProductsController); // true