Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

An overview of all decorators #752

Closed
reilem opened this issue Nov 24, 2020 · 1 comment
Closed

An overview of all decorators #752

reilem opened this issue Nov 24, 2020 · 1 comment
Labels
Community 👨‍👧 Something initiated by a community Duplicate 🔑 This issue or pull request already exists

Comments

@reilem
Copy link

reilem commented Nov 24, 2020

Describe the issue
It would be nice to have a list of all decorators available, similar to class-validator has: https://github.com/typestack/class-validator#validation-decorators

This offers a good quick overview of everything that is possible, and could contain links to the actual docs with more info.

Are you able to make a PR that fix this?
It would be nice to first know if this is something that will be added, and where (README or docs site). But if it's not too much work I could give it a go 😄

Additional context
Overall this project feels like it is lacking a formal "API Reference" docs. The documentation right now is nicely formatted and a good read when you have time, but not a great way to quickly find what you are looking for. This is maybe for another time though. For now just a list of all supported decorators would probably help both newcomers and regular users refresh their knowledge and find what they are looking for.

@MichalLytek
Copy link
Owner

@reilem Thanks for reporting this 😉

I will close this issue in favor of #17 where I'll track the progress.
In the meantime you can explore d.ts file to know about all available decorators. There are not so many like with class-validators and they all are described in the docs text.

@MichalLytek MichalLytek added Community 👨‍👧 Something initiated by a community Duplicate 🔑 This issue or pull request already exists labels Nov 25, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Community 👨‍👧 Something initiated by a community Duplicate 🔑 This issue or pull request already exists
Projects
None yet
Development

No branches or pull requests

2 participants