Skip to content

Commit

Permalink
docs: add @tsed/core/utils
Browse files Browse the repository at this point in the history
  • Loading branch information
Romakita committed Dec 6, 2024
1 parent 259d7c2 commit 4b44faf
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 2 deletions.
7 changes: 6 additions & 1 deletion docs/docs/model.md
Original file line number Diff line number Diff line change
Expand Up @@ -442,7 +442,12 @@ class MyController {
### LabelledAs <Badge text="7.85.0+"/>

The @@LabelledAs@@ decorator is used to set a label to decorated property.
This label will be used to generate a reference for the schema related to the decorated property.

This label will be used to generate a reference for the schema related to the decorated property. This is particularly useful when:

- You want to create reusable schema components
- You need to maintain consistent schema references across your API
- You want to improve the readability of your generated swagger.json

```typescript
import {LabelledAs} from "@tsed/schema";
Expand Down
2 changes: 1 addition & 1 deletion tsdoc.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ module.exports = {
"!<rootDir>/packages/**/constants",
"!<rootDir>/packages/**/registries",
"!<rootDir>/packages/**/lib/**/hooks",
"!<rootDir>/packages/**/utils",
"!<rootDir>/packages/{di,engines,orm,perf,platform,security,specs,third-parties}/**/utils",
"!<rootDir>/packages/perf",
"!<rootDir>/packages/orm/prisma",
"!<rootDir>/packages/third-parties/components-scan",
Expand Down

0 comments on commit 4b44faf

Please sign in to comment.