Description
@tsed/schema
Usage
typescript
import { Description } from "@tsed/schema";See /packages/specs/schema/src/types/decorators/common/description.ts.
Overview
ts
function Description(description: any): (...args: any[]) => any;Description
Add a description to the class, method or property
Examples
On class
typescript
@Description("description")
class Model {
}On method
typescript
@Controller("/")
class ModelCtrl {
@Description("description")
async method() {}
}On parameter
typescript
@Controller("/")
class ModelCtrl {
async method(@Description("description") @PathParam("id") id: string) {}
}On property
typescript
class Model {
@Description("description")
id: string;
}