search

pushrax / node-rcon

A generic RCON protocol client for node.js
MIT License
134 stars 31 forks source link

Added code documentation with Type Annotations to node-rcon (Node v17.3.0 - npm v8.3.2) #43

Open SweetieRick opened 2 years ago

SweetieRick commented 2 years ago

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() function

Schermata 2022-04-17 alle 13 20 01

Addendum: 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)

SweetieRick commented 2 years ago

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 👍