docs: sizeUploaded and timeRemaining functions documentated.

AidasK · AidasK · commit ed14b49fd6c6 · 2013-10-14T11:08:11.000+03:00
diff --git a/README.md b/README.md
@@ -142,6 +142,8 @@ set singleFile to true.
 * `.removeFile(file)` Cancel upload of a specific `FlowFile` object on the list from the list.
 * `.getFromUniqueIdentifier(uniqueIdentifier)` Look up a `FlowFile` object by its unique identifier.
 * `.getSize()` Returns the total size of the upload in bytes.
+* `.sizeUploaded()` Returns the total size uploaded of all files in bytes.
+* `.timeRemaining()` Returns remaining time to upload all files in seconds. Accuracy is based on average speed. If speed is zero, time remaining will be equal to positive infinity `Number.POSITIVE_INFINITY`
 
 #### Events
 
@@ -155,11 +157,11 @@ added.
 * `.filesAdded(array, event)` Same as fileAdded, but used for multiple file validation.
 * `.filesSubmitted(array, event)` Can be used to start upload of currently added files.
 * `.fileRetry(file)` Something went wrong during upload of a specific file, uploading is being retried.
-* `.fileError(file, message)` An error occured during upload of a specific file.
+* `.fileError(file, message)` An error occurred during upload of a specific file.
 * `.uploadStart()` Upload has been started on the Flow object.
 * `.complete()` Uploading completed.
 * `.progress()` Uploading progress.
-* `.error(message, file)` An error, including fileError, occured.
+* `.error(message, file)` An error, including fileError, occurred.
 * `.catchAll(event, ...)` Listen to all the events listed above with the same callback function.
 
 ### FlowFile
@@ -189,8 +191,7 @@ FlowFile constructor can be accessed in `Flow.FlowFile`.
 * `.isUploading()` Returns a boolean indicating whether file chunks is uploading.
 * `.isComplete()` Returns a boolean indicating whether the file has completed uploading and received a server response.
 * `.sizeUploaded()` Returns size uploaded in bytes.
-* `.timeRemaining()` Returns remaining time to upload in seconds. Accuracy is based on average
-speed.
+* `.timeRemaining()` Returns remaining time to finish upload file in seconds. Accuracy is based on average speed. If speed is zero, time remaining will be equal to positive infinity `Number.POSITIVE_INFINITY`
 * `.getExtension()` Returns file extension in lowercase.
 * `.getType()` Returns file type.
 
diff --git a/src/flow.js b/src/flow.js
@@ -585,6 +585,7 @@
 
     /**
      * Returns remaining time to upload all files in seconds. Accuracy is based on average speed.
+     * If speed is zero, time remaining will be equal to positive infinity `Number.POSITIVE_INFINITY`
      * @function
      * @returns {number}
      */
@@ -919,7 +920,8 @@
     },
 
     /**
-     * Time remaining in seconds
+     * Returns remaining time to finish upload file in seconds. Accuracy is based on average speed.
+     * If speed is zero, time remaining will be equal to positive infinity `Number.POSITIVE_INFINITY`
      * @function
      * @returns {number}
      */
diff --git a/test/uploadSpec.js b/test/uploadSpec.js
@@ -427,6 +427,5 @@ describe('upload file', function() {
     expect(fileSecond.timeRemaining()).toBe(0);
     expect(flow.sizeUploaded()).toBe(15);
     expect(flow.timeRemaining()).toBe(0);
-
   });
 });
