Skip to content

Clarify return types for Capacitor iOS plugins#471

Open
riderx wants to merge 9 commits intoionic-team:mainfrom
riderx:better-plugin-doc
Open

Clarify return types for Capacitor iOS plugins#471
riderx wants to merge 9 commits intoionic-team:mainfrom
riderx:better-plugin-doc

Conversation

@riderx
Copy link

@riderx riderx commented Nov 11, 2025

Enhance documentation by clarifying the return types for Capacitor iOS plugins, detailing how each return type affects the interaction between JavaScript and native code.

@vercel
Copy link

vercel bot commented Nov 11, 2025

@riderx is attempting to deploy a commit to the Ionic Team on Vercel.

A member of the Team first needs to authorize it.

Copilot AI review requested due to automatic review settings February 10, 2026 02:14
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds clarification to the iOS plugin creation guide about Capacitor plugin method returnType values and how they affect the JS↔native bridge.

Changes:

  • Documented the three iOS returnType values (CAPPluginReturnNone, CAPPluginReturnPromise, CAPPluginReturnCallback) in the iOS plugin guide.
  • Added this clarification to both the current docs and the versioned v7 docs.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 6 comments.

File Description
docs/plugins/creating-plugins/ios-guide.md Adds a new section explaining iOS plugin returnType behaviors.
versioned_docs/version-v7/plugins/creating-plugins/ios-guide.md Mirrors the new returnType explanation in the v7 snapshot.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

riderx and others added 7 commits March 8, 2026 13:02
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants