Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Typed API Responses #596

Closed
dbateman opened this issue Jun 24, 2022 · 1 comment
Closed

Typed API Responses #596

dbateman opened this issue Jun 24, 2022 · 1 comment
Labels
new-feature-request Feature request that needs triage Team Lamprey

Comments

@dbateman
Copy link

dbateman commented Jun 24, 2022

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 dbateman added the new-feature-request Feature request that needs triage label Jun 24, 2022
@Eric-Warehime
Copy link
Contributor

We've had a few similar requests for this. I'm going to consolidate them all in #771 and close this one. Please +1 that issue and follow resolution there.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new-feature-request Feature request that needs triage Team Lamprey
Projects
None yet
Development

No branches or pull requests

3 participants