Top-gg-Community / node-sdk

An official module for interacting with the Top.gg API

https://topgg.js.org/

133 stars 42 forks source link

Added `Autoposting`. No need for using `topgg-autoposter` anymore #58

Closed moyshik7 closed 3 years ago

moyshik7 commented 3 years ago

What I added new

Added Autopost.ts in src/structs/
- Added init() function in Autopost. It'll post the stats after a certain time (default 20 min)
- Added post() function in Autopost. It'll post the stats as ready
Added example.md in docs/
- Added Most used examples (API, Webhook and Autopost)
- Added examples for both Ecmascript import and node require

For all changes see /whatisnew.md ty

Xetera commented 3 years ago

Excluding autoposter functionality was an intentional design decision. There's no reason for an SDK for Top.gg to know or care about Discord libraries, especially since going forward we're no longer going to be a Discord-only company.

If we add discord.js support we also have to add eris and any other arbitrary Discord library, on top of keeping up with all their updates and breaking changes and that's just not the purpose of this library. If you want that functionality you're free to use topgg-autoposter but for @top-gg/sdk I do not want to have Discord libraries as a dependency or a peerDependency.

In the future please open an issue first to discuss a feature you want to add (or write in #topgg-open-source in the discord server) so you don't risk putting effort into a PR we can't merge.

jpbberry commented 3 years ago

That's unfortunate, sorry you did all this work. Regarding autoposting in the package, we decided to only cover the Top.gg API as it begins to move away from only Discord bots. That's why it was removed from the old package. Hence why the topgg-autoposter was created in the first place in conjunction with the rewrite of the node SDK. I appreciate the work though!