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

Better typings #8612

Closed
2 tasks
John0x opened this issue Jul 21, 2021 · 6 comments
Closed
2 tasks

Better typings #8612

John0x opened this issue Jul 21, 2021 · 6 comments
Labels
feature-request Request a new feature fixed-in-dev-preview Issues that are fixed in v6 dev preview TypeScript Related to TypeScript issues

Comments

@John0x
Copy link

John0x commented Jul 21, 2021

Is this related to a new or existing framework?

No response

Is this related to a new or existing API?

No response

Is this related to another service?

No response

Describe the feature you'd like to request

The typings for the aws-amplify js library are lacking in a lot of places, and the lack of support from the aws team is concerning.

See: #4927
There was one response from an official contributor (@sammartinez), which was obviously not helping, to be honest. A lot of projects, nowadays, use typescript and therefore require accurate typings. The issue is older than a year and the problem hasn't even been addressed properly yet, at least from what I've read.

The issue should not have been closed.

Describe the solution you'd like

Add proper types that accurately match the actual object.

Describe alternatives you've considered

Writing my own types, which I have. That should not be considered a solution tho

Additional context

No response

Is this something that you'd be interested in working on?

  • 👋 I may be able to implement this feature request
  • ⚠️ This feature might incur a breaking change
@John0x John0x added the feature-request Request a new feature label Jul 21, 2021
@aaronmcadam
Copy link

Describe alternatives you've considered
Writing my own types, which I have. That should not be considered a solution tho

Would you mind sharing your custom types, @John0x?

@jcuervas
Copy link

jcuervas commented Aug 4, 2021

I support this feature request, for example, i'm trying to guess what to pass to this Amplify.configure(). According to reference this is what i got:
https://aws-amplify.github.io/amplify-js/api/classes/amplify.html#configure
and this
https://github.com/aws-amplify/amplify-js/blob/a047ce73/packages/core/src/Amplify.ts#L37
Therefore i have no idea how to use this except by researching for some example.

@sammartinez sammartinez added the TypeScript Related to TypeScript issues label Aug 4, 2021
@aaronmcadam
Copy link

I think it would be good to collect together some of the typings that the community has created to see where the gaps are.

@jimblanc
Copy link
Contributor

We have published an RFC on our plan for improving TypeScript support in Amplify JS & would love to get your feedback & suggestions!

RFC: Amplify JS TypeScript Improvements

@cwomack
Copy link
Contributor

cwomack commented Oct 3, 2023

The developer preview for v6 of Amplify has officially been released with improved support for TypeScript and much more! Please check out our announcement and updated documentation to see what has changed.

This issue should be resolved within the dev preview and upcoming General Availability for Amplify v6, but let us know with a comment if there are further issues.

@cwomack cwomack added the fixed-in-dev-preview Issues that are fixed in v6 dev preview label Oct 3, 2023
@cwomack
Copy link
Contributor

cwomack commented Nov 16, 2023

With the release of the latest major version of Amplify (aws-amplify@>6), this issue should now be resolved! Please refer to our release announcement, migration guide, and documentation for more information.

@cwomack cwomack closed this as completed Nov 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature-request Request a new feature fixed-in-dev-preview Issues that are fixed in v6 dev preview TypeScript Related to TypeScript issues
Projects
None yet
Development

No branches or pull requests

6 participants