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

Clarify return types #356

Closed
larrysalibra opened this issue Jan 27, 2018 · 2 comments
Closed

Clarify return types #356

larrysalibra opened this issue Jan 27, 2018 · 2 comments
Labels
enhancement Iterations/refactor on existing features/infrastructure/tests

Comments

@larrysalibra
Copy link
Contributor

We should clarify return types in all of our public api methods.

This means making it clear to developers not only the general type of the return value, but the schema of the value when the return value is an object.

@vsund was kind enough to bring this up as part of his creation of typescript definitions for this library #336

@larrysalibra larrysalibra added enhancement Iterations/refactor on existing features/infrastructure/tests backlog labels Jan 27, 2018
@vsund
Copy link
Contributor

vsund commented Feb 1, 2018

While resolving this, it may make sense to go through the TypeScript type declarations and correct/improve the wrong ones.

@yknl
Copy link
Contributor

yknl commented Oct 10, 2019

The entire library has now been converted to Typescript and should provide return types.

@yknl yknl closed this as completed Oct 10, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Iterations/refactor on existing features/infrastructure/tests
Projects
None yet
Development

No branches or pull requests

3 participants