agiledigital / idm-ts-types

ForgeRock IDM TypeScript Types
Apache License 2.0
11 stars 3 forks source link

Document global types and API wrappers #7

Open pearj opened 5 years ago

pearj commented 5 years ago

The API wrappers and global types would benefit from documentation, as it would be helpful when IDE's are doing type-ahead assistance.

We should be able to grab the documentation in the integrators guide and add it to the relevant functions.

https://backstage.forgerock.com/docs/idm/6.5/integrators-guide/#appendix-scripting

pearj commented 2 years ago

This is largely resolved. There is a bit more left on the api docs internally.