US-Trustee-Program / Bankruptcy-Oversight-Support-Systems

Other

6 stars 1 forks source link

Fix jsdocs #919

Closed jamesobrooks closed 1 month ago

jamesobrooks commented 1 month ago

Purpose

When we have JSDocs, it is most helpful if they properly follow the syntax.

Major Changes

Move types to their proper place in @param tags.
Add @return tags where needed.
Add @template tags where generics are used.
Add stronger typing to api2.ts interface and functions as the JSDoc actually caused build failures without these changes.

Testing/Validation

Ran build successfully.