Merge pull request #451 from h4ck-rOOt/download-response-ext

feat: response object on file download

Author: silkimen

README.md

@@ -414,21 +414,32 @@ cordova.plugin.http.uploadFile("https://google.com/", {
 ```
 
 ### downloadFile<a name="downloadFile"></a>
-Downloads a file and saves it to the device.  Takes a URL, parameters, headers, and a filePath.  See [post](#post) documentation for details on what is returned on failure.  On success this function returns a cordova [FileEntry object](http://cordova.apache.org/docs/en/3.3.0/cordova_file_file.md.html#FileEntry).
+Downloads a file and saves it to the device.  Takes a URL, parameters, headers, and a filePath.  See [post](#post) documentation for details on what is returned on failure.  On success this function returns a cordova [FileEntry object](http://cordova.apache.org/docs/en/3.3.0/cordova_file_file.md.html#FileEntry) as first and the response object as second parameter.
 
 ```js
-cordova.plugin.http.downloadFile("https://google.com/", {
-  id: '12',
-  message: 'test'
-}, { Authorization: 'OAuth2: token' }, 'file:///somepicture.jpg', function(entry) {
-  // prints the filename
-  console.log(entry.name);
-
-  // prints the filePath
-  console.log(entry.fullPath);
-}, function(response) {
-  console.error(response.error);
-});
+cordova.plugin.http.downloadFile(
+  "https://google.com/", 
+  { id: '12', message: 'test' },
+  { Authorization: 'OAuth2: token' },
+  'file:///somepicture.jpg',
+  // success callback
+  function(entry, response) {
+    // prints the filename
+    console.log(entry.name);
+
+    // prints the filePath
+    console.log(entry.fullPath);
+
+    // prints all header key/value pairs
+    Object.keys(response.headers).forEach(function (key) {
+      console.log(key, response.headers[key]);
+    });
+  }, 
+  // error callback
+  function(response) {
+    console.error(response.error);
+  }
+);
 ```
 
 ### abort<a name="abort"></a>
@@ -445,12 +456,15 @@ If the request is still in progress, the request's `failure` callback will be in
 var requestId = cordova.plugin.http.downloadFile("https://google.com/", {
   id: '12',
   message: 'test'
-}, { Authorization: 'OAuth2: token' }, 'file:///somepicture.jpg', function(entry) {
+}, { Authorization: 'OAuth2: token' }, 'file:///somepicture.jpg', function(entry, response) {
   // prints the filename
   console.log(entry.name);
 
   // prints the filePath
   console.log(entry.fullPath);
+
+  // prints the status code
+  console.log(response.status);
 }, function(response) {
   // if request was actually aborted, failure callback with status -8 will be invoked
   if(response.status === -8){

www/helpers.js

@@ -343,7 +343,10 @@ module.exports = function init(global, jsUtil, cookieHandler, messages, base64,
 
   function injectFileEntryHandler(cb) {
     return function (response) {
-      cb(createFileEntry(response.file));
+      var fileEntry = createFileEntry(response.file);
+      response.file = fileEntry;
+      response.data = fileEntry;
+      cb(fileEntry, response);
     }
   }