Ionic-framework: feat: pass T in onDidDismiss to OverlayEventDetail

[nickwinger]

Feature Request

the onDidDismiss, e.g. for a Modal, returns OverlayEventDetail<any>.
The any is poor for coding, it would be better to be able to pass T.
Right now onDidDismiss is defined like so:
"onDidDismiss": () => Promise<OverlayEventDetail<any>>;
please change to
"onDidDismiss": <T = any>() => Promise<OverlayEventDetail<T>>;

so T is still optional, but if you want, you can have it typed now.

Ionic version:


[x] 4.x

Describe the Feature Request

Describe Preferred Solution

Describe Alternatives

Related Code

Additional Context

[ionitron-bot[bot]]

This issue has been labeled as help wanted. This label is added to issues that we believe would be good for contributors.

If you'd like to work on this issue, please comment here letting us know that you would like to submit a pull request for it. This helps us to keep track of the pull request and make sure there isn't duplicated effort.

For a guide on how to create a pull request and test this project locally to see your changes, see our contributing documentation.

Thank you!

[aivinog1]

@liamdebeasi Hello, I would like to take this. May I do this issue?

[liamdebeasi]

Yes, thank you!

Here is our contributing guide that gives you an overview of how to make the changes, test, and create a PR: https://github.com/ionic-team/ionic/blob/master/.github/CONTRIBUTING.md#creating-a-pull-request.

Let me know if you have any questions 😊.

[nickwinger]

Nice, didn‘t know that this is possible. Next time i contribute right away :)

[nickwinger]

@aivinog1 maybe you can look out for other locations where it‘s just any and change to T=any so we have the possibility to type it.

[aivinog1]

@nickwinger Yes, I'll try to find such methods, but if there are too many such methods I think that the best solution is to split such PR to many.

In the first iteration, I can find all the possible places and describe them in the comments of this task.

[aivinog1]

I've created a #21393 and I see other places when typing could be added:

• https://github.com/ionic-team/ionic/blob/53fc8e37c89cea793d0e00246d52805166730108/core/api.txt#L908
• https://github.com/ionic-team/ionic/blob/53fc8e37c89cea793d0e00246d52805166730108/core/api.txt#L1046
• https://github.com/ionic-team/ionic/blob/53fc8e37c89cea793d0e00246d52805166730108/core/api.txt#L1080

[liamdebeasi]

Thanks for the feature request. This has been added via https://github.com/ionic-team/ionic/pull/21393 and will be available in an upcoming release of Ionic Framework.

[ionitron-bot[bot]]

Thanks for the issue! This issue is being locked to prevent comments that are not relevant to the original issue. If this is still an issue with the latest version of Ionic, please create a new issue and ensure the template is fully filled out.