Added code documentation with Type Annotations to node-rcon (Node v17.3.0 - npm v8.3.2) #43
Conversation
This file contains hidden or 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
|
Alright, thanks for the review! I've closed all conversations except for Conversation 2; I will wait for further instructions in order to implement the changes in a way that fits everyone 👍 |
kzyqq00-Player
approved these changes
Dec 21, 2024
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.
Trough the use of Type Annotation, I've added some code documentation for the node-rcon package. I've also cleaned up some functions to allow better code readability.
Below is a screenshot of the code documentation for the
connect()functionAddendum: The last commit broke compatibility with pre-ES2015 syntaxt. With further testing, I've build a final version that works as intended and works on the newest stable release of NodeJS (v17.3.0 - npm v8.3.2)