Update README.md

Add a comment for begin prop for downloadFile method
itinance · Apr 8, 2022 · 76f9baf · 76f9baf
1 parent fcb62f6
commit 76f9baf
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -265,7 +265,8 @@ var files = [
   }
 ];
 
-var uploadBegin = (response) => {
+var upload
+= (response) => {
   var jobId = response.jobId;
   console.log('UPLOAD HAS BEGUN! JobId: ' + jobId);
 };
@@ -558,7 +559,7 @@ type DownloadFileOptions = {
   cacheable?: boolean;      // Whether the download can be stored in the shared NSURLCache (iOS only, defaults to true)
   progressInterval?: number;
   progressDivider?: number;
-  begin?: (res: DownloadBeginCallbackResult) => void;
+  begin?: (res: DownloadBeginCallbackResult) => void; // Note: it is required when progress prop provided
   progress?: (res: DownloadProgressCallbackResult) => void;
   resumable?: () => void;    // only supported on iOS yet
   connectionTimeout?: number // only supported on Android yet