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.

Sign up for GitHub

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

Jump to bottom

feat: generate typescript definitions #354

Merged
merged 10 commits into from
Nov 23, 2021
Merged

feat: generate typescript definitions #354

merged 10 commits into from
Nov 23, 2021

Conversation

dselman
Copy link
Contributor

@dselman dselman commented Nov 22, 2021 •
edited
Loading

Signed-off-by: Dan Selman [email protected]

Closes #170

Uses tsc to generate the Typescript definitions from JSDoc comments.

Changes

  • Adds a build:types script to package.json to programmatically generate the Typescript type definitions
  • Improves the API signature generation (support for optional and union types)

Author Checklist

  • Ensure you provide a DCO sign-off for your commits using the --signoff option of git commit.
  • Vital features and changes captured in unit and/or integration tests
  • Commits messages follow AP format
  • Extend the documentation, if necessary
  • Merging to master from fork:branchname

@dselman dselman requested a review from jeromesimeon November 22, 2021 17:42
@dselman dselman merged commit d31da68 into master Nov 23, 2021
@dselman dselman deleted the ds-generate-ts branch November 23, 2021 01:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jeromesimeon jeromesimeon Awaiting requested review from jeromesimeon

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

JSDoc and TypeScript for ModelManager.addModelFiles is inconsistent with code
1 participant
@dselman