js-algorand-sdk icon indicating copy to clipboard operation
js-algorand-sdk copied to clipboard

Typed API Responses

Open dbateman opened this issue 3 years ago • 0 comments

Problem

It appears that most response types for API calls are Promise<any>. For us TS users, rather than knowing the shape of these responses, we have to look up docs or experiment with direct API calls to understand what is being returned. This is slow.

Solution

Type the responses, rather than returning any.

Dependencies

This would potentially lock client libraries to compatible ranges of servers and I'm guessing this is why it hasn't been done?

Urgency

For me at least, this is a productivity issue and means developing for Algorand is far less efficient than it could be. I chose to develop on Algorand because it offers (IMHO) a better development experience than other alt chains. This would help elevate it further as typed language support is important for enterprise development.

Acceptance Criteria

  • Review the code and propose a solution. Followup work would address the problem.

dbateman avatar Jun 24 '22 07:06 dbateman