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

Fix JSDoc type definitions on service APIs #1379

Closed
nikku opened this issue Nov 27, 2020 · 1 comment
Closed

Fix JSDoc type definitions on service APIs #1379

nikku opened this issue Nov 27, 2020 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@nikku
Copy link
Member

nikku commented Nov 27, 2020 •
edited
Loading

What should we do?

Related to #1378 we should fix the JSDoc types on service APIs so that proper type hinting can be done.

Why should we do it?

This allows introspection of API usage and, within a TypeScript code base, allows users to detect structural API miss-use.

Child of #1002

Depends on #1378
@nikku nikku changed the title Fix type definitions on service APIs Fix JSDoc type definitions on service APIs Nov 27, 2020
@nikku nikku mentioned this issue Nov 27, 2020
Closed
6 tasks
@nikku nikku added the backlog Queued in backlog label Nov 27, 2020 — with bpmn-io-tasks
@nikku nikku added the documentation Improvements or additions to documentation label Nov 27, 2020
@philippfromme
Copy link
Contributor

Closed by https://github.com/bpmn-io/internal-docs/issues/688. bpmn-js@13 includes type declarations.

@bpmn-io-tasks bpmn-io-tasks bot removed the backlog Queued in backlog label Apr 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@nikku @philippfromme