Return Types + Accepting Period in constructor

[akash-joshi]

Hey guys these might be 2 seperate issues, but it looks like:

1. If return type was either documented on the README, or returned as a TS type, it would make it much easier to use this library, instead of having to console.log the output.
2. The time period is set fixed to 300, but having it modifiable via the initializer and having a default value of 300 here might be a much better Developer Experience.

Let me know what you guys think.

[ArtemKo7v]

Hello

Thank you for the feedback!

The return types of the MonitorClient class methods are documented in JSDoc format in source code, shown in class reference and recognized by IDEs. If you're talking about detailed descriptions of the objects returned by methods or used in parameters or callbacks - we will soon add all the missing information, sorry for the inconveniences.

Default period value can be overridden using options object.

const monitorApp = new MonitorApp('EK-XXXXX-XXXXX-XXXXX', { period: 600 });

And the same way for MonitorClient class.
Detailed description will be added to the reference later, at the moment default values can be peeked in the source code.