chore: add JSDocs to improve maintainability and tooling support #129
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
adam-coster
commented
Mar 27, 2023
| @@ -16,6 +16,8 @@ | |||
| "semver": "^7.3.2" | |||
| }, | |||
| "devDependencies": { | |||
| "@types/node": "^18.15.10", | |||
There was a problem hiding this comment.
Provides editor support for Typescript-aware IDEs.
adam-coster
commented
Mar 27, 2023
| @@ -213,28 +234,31 @@ class Updates { | |||
| PLATFORM_ARCH.WIN_IA32, | |||
| PLATFORM_ARCH.WIN_ARM64, | |||
| ]) { | |||
| if (latest[key]) { | |||
| const rurl = `https://github.com/${account}/${repository}/releases/download/${latest[key].version}/RELEASES`; | |||
| const the_latest = latest[key]; | |||
There was a problem hiding this comment.
This block contains the only functional changes I made. Their only purpose is to get better type support, since latest[key] shows up as Latest|undefined even inside the if(latest[key]){} block.
erickzhao
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Before drafting a PR for #128, I wanted to make sure I had enough editor support to make safe changes. So I added JSDocs to most of the code.
All changes are non-functional except for one very minor name refactor.
This PR closes #130