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

[Bug]: Update CapacitorHttp "Large File Support" doc, fix Filesystem.downloadFile() doc #7477

Closed
3 tasks done
bluepuma77 opened this issue May 22, 2024 · 3 comments
Closed
3 tasks done
Labels

Comments

@bluepuma77
Copy link

Capacitor Version

💊 Capacitor Doctor 💊

Latest Dependencies:

@capacitor/cli: 6.0.0
@capacitor/core: 6.0.0
@capacitor/android: 6.0.0
@capacitor/ios: 6.0.0

Installed Dependencies:

@capacitor/android: not installed
@capacitor/cli: 6.0.0
@capacitor/core: 6.0.0
@capacitor/ios: 6.0.0

[success] iOS looking great! 👌

Other API Details

No response

Platforms Affected

  • iOS
  • Android
  • Web

Current Behavior

Current CapacitorHttp doc states:

Large File Support
Due to the nature of the bridge, parsing and transferring large amount of data from native to the web can cause issues. Support for downloading and uploading files to the native device is planned to be added to the @capacitor/filesystem plugin in the near future.

Expected Behavior

Instead it should probably be updated and link to Filesystem.downloadFile() doc.

At the same time Filesystem.downloadFile() doc needs to be improved, as it is totally missing all the HttpOptions from CapacitorHttp, currently only shows path and directory as parameters, but something like url is probably needed for a download ;-)

Some note in the other direction on how to enable CapacitorHttp for Filesystem.downloadFile() might help, too.

Project Reproduction

https://forum.ionicframework.com/t/how-to-use-filesystem-downloadfile-how-to-set-url/241420

Additional Information

No response

@jcesarmobile
Copy link
Member

It's a problem on the docs generator, already mentioned on ionic-team/capacitor-plugins#1884 (comment)

@jcesarmobile jcesarmobile closed this as not planned Won't fix, can't repro, duplicate, stale May 22, 2024
@bluepuma77

This comment was marked as abuse.

Copy link

ionitron-bot bot commented Jun 21, 2024

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 Capacitor, please create a new issue and ensure the template is fully filled out.

@ionitron-bot ionitron-bot bot locked and limited conversation to collaborators Jun 21, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

2 participants