docs: Better documentation on File Transfer errors.#56
Merged
Conversation
This is not a new parameter, it was already being returned by the plugin, just not available in the interface
FileTransferError was not being used explicitly, hence why we added an internal field to the API so that docgen picks it up.
theproducer
approved these changes
Jan 27, 2026
alexgerardojacinto
approved these changes
Jan 29, 2026
OS-pedrogustavobilro
added a commit
that referenced
this pull request
Feb 11, 2026
* docs: Make explict regarding http errors * docs: FileTransferError Android / iOS only * docs: mention headers This is not a new parameter, it was already being returned by the plugin, just not available in the interface * docs: Add error handling to examples * chore: Make FileTransferError discoverable by docgen FileTransferError was not being used explicitly, hence why we added an internal field to the API so that docgen picks it up. * chore: fix lint issues * chore: fix lint issues in web.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Partially addresses #18 - Another PR will be open to address response body not arriving in iOS.
See commit messages for a list of changes.
Note that while this PR adds
headerstoFileTransferErrorinterface, this is not a new feature, but rather a documentation update as this field was already being returned by native before, it was just not made explicit on TypeScript API.