Expose typedoc docs

[jdegger]

Hi

It would be wonderful if you could expose the TypeDoc automatically generated docs, I think this will be beneficial for loads of users.

https://typedoc.org/

Especially the methods in FusionAuthClient are ideal. I know loads of IDEs expose all the type hinting automatically, be we are in an older project without all the fancy typescript stuff which makes the documentation a must-have

[robotdan]

We’ll have to figure out what we need to change to publish this when we publish to npm.

[jdegger]

You could generate the docs folder through typedoc and deploy that in GitHub pages right on you main branch or create a separate branch with the docs for all releases.

To keep the docs out of your npm package you could add docs folder to .npmignore

[jdegger]

Additionally, an example of the current TypeDoc output:

docs.zip

The path /docs/classes/fusionauthclient.html is the most interesting imo, typedoc might need some tweaking to make the overview a bit more readable https://typedoc.org/guides/options/#toc

Output of npx typedoc ./index.ts --toc FusionAuthClient: docs 2.zip

[robotdan]

Thanks for the additional insight @jdegger much appreciated.