question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Clean up API/API documentation

See original GitHub issue

Hey, I was looking at the overwatch-api npm package’s documentation and I saw that the callback supposedly takes two arguments, err and data, where err contains error info and data is the response from the server, but as far as I can tell the second argument data is never actually used, and the first argument is used for both. I’m currently in the process of making a TypeScript types declaration file for the overwatch-api package so it would be helpful if you could either fix this or point me in the right direction for how the package works, thanks!

P.S. I really appreciate the work you’ve done on this package, nice to not have to manually figure this out myself 👍

Issue Analytics

  • State:closed
  • Created 5 years ago
  • Comments:6 (4 by maintainers)

github_iconTop GitHub Comments

1reaction
JoshuaHallcommented, Jun 26, 2018

Here are the completed TypeScript types, it isn’t available by doing npm install @types/overwatch-api or yarn add @types/overwatch-api just yet but the bot that they have to automatically add types should do that soon 😃 Let me know if you have any feedback, this is my first type declaration file of any meaningful size.

1reaction
alfgcommented, Jun 22, 2018

Great, thanks! Would love to see the TypeScript types when those are ready. 😃

Read more comments on GitHub >

github_iconTop Results From Across the Web

Cleanup API - Vertuna WIKI - ConfiForms
Cleanup API. Created by Alex Medved, ... This is the documentation for ConfiForms Server/Data Center app ... Direct URL for Cleanup API is: ......
Read more >
How to write a clean API. Best Practices for REST ... - ITNEXT
Key Requirements for a clean API · Be simple (Flat is better than nested.) · Be consistent (Standardize the style before you start)...
Read more >
Cleaner APIs - People Data Labs
Clean company, school and location names before using them with our Search APIs. Easily clean and standardize your own raw data for your...
Read more >
Docs: Clean up API documentation style guides (#355873) · Issues ...
The following are various tasks we need to tackle as part of cleaning up and consolidating the API style guides for the API...
Read more >
REST and SOAP API analytics collection and cleanup
API analytics uses scheduled jobs to collect and clean up analytics data.
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found