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

fix(vue): strongly typed controller methods #24388

Merged
merged 1 commit into from
Dec 14, 2021
Merged

fix(vue): strongly typed controller methods #24388

merged 1 commit into from
Dec 14, 2021

Conversation

sean-perkins
Copy link
Contributor

Pull request checklist

Please check if your PR fulfills the following requirements:

  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been reviewed and added / updated if needed (for bug fixes / features)
  • Build (npm run build) was run locally and any changes were pushed
  • Lint (npm run lint) has passed locally and any fixes were made for failures

Pull request type

Please check the type of change your PR introduces:

  • Bugfix
  • Feature
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • Documentation content changes
  • Other (please describe):

What is the current behavior?

All generated controllers for the Vue package have a return type of any.

Issue Number: Resolves #24387

What is the new behavior?

All controllers for the Vue package will return the original type of the controller exported from @ionic/core/components.

Does this introduce a breaking change?

  • Yes
  • No

Other information

@sean-perkins sean-perkins requested a review from a team December 14, 2021 04:58
@github-actions github-actions bot added the package: vue @ionic/vue package label Dec 14, 2021
Copy link
Contributor

@liamdebeasi liamdebeasi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sean-perkins
Copy link
Contributor Author

Would it make sense to use this type instead? https://github.com/ionic-team/ionic-framework/blob/main/core/src/utils/overlays-interface.ts#L34

I would recommend this implementation over type casting that interface, as this will pull through all the types of the individual controllers; which includes their true HTMLElement type (i.e. HTMLIonModalElement).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
package: vue @ionic/vue package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

bug: Controllers are typed as any after upgrading to Ionic 6
3 participants