docs(http): FormData and other complex types do not work on Capacitor…

…Http plugin methods on native platforms (#7132) Co-authored-by: Chace Daniels <[email protected]> Co-authored-by: Dan Giralté <[email protected]>
ionic-team · Dec 14, 2023 · dfc97ee · dfc97ee
1 parent 3862d6e
commit dfc97ee
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/core/src/core-plugins.ts b/core/src/core-plugins.ts
@@ -165,6 +165,14 @@ export interface HttpOptions {
   url: string;
   method?: string;
   params?: HttpParams;
+  /**
+   * Note: On Android and iOS, data can only be a string or a JSON.
+   * FormData, Blob, ArrayBuffer, and other complex types are only directly supported on web
+   * or through enabling `CapacitorHttp` in the config and using the patched `window.fetch` or `XMLHttpRequest`.
+   *
+   * If you need to send a complex type, you should serialize the data to base64
+   * and set the `headers["Content-Type"]` and `dataType` attributes accordingly.
+   */
   data?: any;
   headers?: HttpHeaders;
   /**