API reference with JSDocs

[MichalLytek]

• create JSDoc for all decorators and public interfaces/functions/etc.
• create docs section with API Reference (text from JSDoc, samples from item signature)
• investigate usage of TypeDoc
• configure website to show API reference

[tradical-allstripes]

Any update on this? API Reference Documentation has always been key for me, and, as much as I love this project, this may influence our decision about whether to use it.

In the meantime, it would be extremely helpful if you could provide either some links to what you think are the most important definitions, or a strategy to make locating them easier.

[MichalLytek]

The TS definition files are well maintained and acts as an API reference if you forgot about possible decorators options.

TypeGraphQL is more frameworkish so the API reference docs page for e.g. @Resolver decorator could only link to the normal docs page when the resolvers, classes, types, etc. are described.

It's not a library where you can simply describe each function input and output, so there's less demand for such API reference docs page. I have more important tasks and features to do, so it's not on top of my priority list for now.

If anyone from the community want to help and contribute, please feel free to open a PR 😉

[tradical-allstripes]

Ok, that's understandable. Thank you for the reply!

[MichalLytek]

If someone is looking for something more user-friendly than jumping through typescript definitions in IDE, you can try to use a tool called Paka 😉
https://www.paka.dev/npm/type-graphql

[tradical-allstripes]

ah, this is super cool! Thank you!