Add typescript jsdoc for better IDE integration

BrightspaceHypermediaComponents / siren-sdk

This contains tools to help develop and use siren entities.

Apache License 2.0

2 stars 2 forks source link

Closed awikkerink closed 2 weeks ago

awikkerink commented 2 weeks ago

I started looking into adding JSDoc to improve VSCode navigation and tooltips. I've been following https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html. Since this is a commonly used library in our projects, this is a useful place to add typing.

If the IDE doesn't support jsdoc/typescript, there would be no effect, and the extra documentation would be useful.

github-actions[bot] commented 2 weeks ago

Did you use a semver keyword in a commit message?

[ ] Yes I used one in at least one of my commits
[x] No but I will use a semver keyword in the commit message when I merge and squash

Did you paste the Jira ticket URL in the description?

d2l-github-release-tokens[bot] commented 2 weeks ago

:tada: This PR is included in version 3.11.1 :tada:

The release is available on:

Your semantic-release bot :package::rocket: