react-native-fetch-blob - npm Package Compare versions

Comparing version 0.10.3 to 0.10.4

fs.js

@@ -204,4 +204,6 @@ // Copyright 2016 wkh237@github. All rights reserved.
       else {
-        if(stat)
+        if(stat) {
+          stat.size = parseInt(stat.size)
           stat.lastModified = parseInt(stat.lastModified)
+        }
         resolve(stat)
@@ -208,0 +210,0 @@ }

index.js

@@ -223,5 +223,6 @@ // Copyright 2016 wkh237@github. All rights reserved.
   // pass to native context
-  _.each(headers, (h,i) =>  {
-    headers[i] = h || ''
-  });
+  headers = _.reduce(headers, (result, value, key) => {
+    result[key] = value || ''
+    return result
+  }, {});
 
@@ -251,10 +252,8 @@ // fetch from file system
     stateEvent = emitter.addListener('RNFetchBlobState', (e) => {
-      respInfo = e
-      if(e.taskId === taskId && promise.onStateChange) {
-        promise.onStateChange(e)
-      }
+      if(e.taskId === taskId)
+        respInfo = e
+      promise.onStateChange && promise.onStateChange(e)
     })
 
     subscription = emitter.addListener('RNFetchBlobExpire', (e) => {
-      console.log(e , 'EXPIRED!!')
       if(e.taskId === taskId && promise.onExpire) {
@@ -261,0 +260,0 @@ promise.onExpire(e)

net.js

@@ -16,11 +16,22 @@ // Copyright 2016 wkh237@github. All rights reserved.
  * Get cookie according to the given url.
- * @param  {string} url HTTP URL string.
+ * @param  {string} domain Domain of the cookies to be removed, remove all
  * @return {Promise<Array<String>>}     Cookies of a specific domain.
  */
-function getCookies(url:string):Promise<Array<String>> {
-  return RNFetchBlob.getCookies(url)
+function getCookies(domain:string):Promise<Array<String>> {
+  return RNFetchBlob.getCookies(domain || '')
 }
 
+/**
+ * Remove cookies for a specific domain
+ * @param  {?string} domain Domain of the cookies to be removed, remove all
+ * cookies when this is null.
+ * @return {Promise<null>}
+ */
+function removeCookies(domain:?string):Promise<null> {
+  return RNFetchBlob.removeCookies(domain || '')
+}
+
 export default {
-  getCookies
+  getCookies,
+  removeCookies
 }

package.json

 {
   "name": "react-native-fetch-blob",
-  "version": "0.10.3",
+  "version": "0.10.4",
   "description": "A module provides upload, download, and files access API. Supports file stream read/write for process large files.",
@@ -5,0 +5,0 @@ "main": "index.js",

polyfill/Blob.js

@@ -116,3 +116,3 @@ // Copyright 2016 wkh237@github. All rights reserved.
           for(let j in part.headers) {
-            formArray.push(j + ': ' +part.headers[j] + ';\r\n')
+            formArray.push(j + ': ' +part.headers[j] + '\r\n')
           }
@@ -119,0 +119,0 @@ formArray.push('\r\n')

polyfill/Fetch.js

@@ -35,3 +35,2 @@ import RNFetchBlob from '../index.js'
       options.method = options.method || 'GET'
-
       if(body) {
@@ -59,3 +58,2 @@ // When the request body is an instance of FormData, create a Blob cache
       }
-
       // task is a progress reportable and cancellable Promise, however,
@@ -62,0 +60,0 @@ // task.then is not, so we have to extend task.then with progress and

README.md

 # react-native-fetch-blob
 [![release](https://img.shields.io/github/release/wkh237/react-native-fetch-blob.svg?style=flat-square)](https://github.com/wkh237/react-native-fetch-blob/releases) [![npm](https://img.shields.io/npm/v/react-native-fetch-blob.svg?style=flat-square)](https://www.npmjs.com/package/react-native-fetch-blob) ![](https://img.shields.io/badge/PR-Welcome-brightgreen.svg?style=flat-square) [![](https://img.shields.io/badge/Wiki-Public-brightgreen.svg?style=flat-square)](https://github.com/wkh237/react-native-fetch-blob/wiki) [![npm](https://img.shields.io/npm/l/react-native-fetch-blob.svg?maxAge=2592000&style=flat-square)]()
 
-A project committed to make file acess and data transfer easier, efficient for React Native developers.
 
+A project committed to making file access and data transfer easier, efficient for React Native developers.
+> For Firebase Storage solution, please upgrade to latest version for best compatibility.
+
 ## Features
 - Transfer data directly from/to storage without BASE64 bridging
-- File API supports normal files, Asset files, and CameraRoll files
+- File API supports regular files, Asset files, and CameraRoll files
 - Native-to-native file manipulation API, reduce JS bridging performance loss
 - File stream support for dealing with large file
 - Blob, File, XMLHttpRequest polyfills that make browser-based library available in RN (experimental)
+- JSON stream supported base on [Oboe.js](https://github.com/jimhigson/oboe.js/) @jimhigson
 
@@ -34,3 +37,3 @@ ## TOC
 * [API References](https://github.com/wkh237/react-native-fetch-blob/wiki/Fetch-API)
-* [Trouble Shooting](https://github.com/wkh237/react-native-fetch-blob/wiki/Trouble-Shooting)
+* [Caveats](#user-content-caveats)
 * [Development](#user-content-development)
@@ -40,3 +43,4 @@
 
-This project was initially for solving the issue [facebook/react-native#854](https://github.com/facebook/react-native/issues/854), because React Native lack of `Blob` implementation and it will cause some problem when transferring binary data. Now, this project is committed to make file access and transfer more easier, efficient for React Native developers. We've implemented highly customizable filesystem and network module which plays well together. For example, upload and download data directly from/to storage which is much more efficient in some cases(especially for large ones). The file system supports file stream, so you don't have to worry about OOM problem when accessing large files.
+This project was initially for solving the issue [facebook/react-native#854](https://github.com/facebook/react-native/issues/854) because React Native lack of `Blob` implementation and it's problematic when transferring binary data. Now the project is committed to making file access and transfer easier, efficient for React Native developers. 
+We've implemented highly customizable filesystem and network module which plays well together. For example, upload and download data directly from/to storage which is much more efficient in some cases(especially for large ones). The file system supports file stream, so you don't have to worry about OOM problem when accessing large files.
 
@@ -57,9 +61,15 @@ In `0.8.0` we introduced experimental Web API polyfills that make it possible to use browser-based libraries in React Native, such as, [FireBase JS SDK](https://github.com/wkh237/rn-firebase-storage-upload-sample)
 ```
-pod 'react-native-fetch-blob,
-    :path => '../node_modules/react-native-fetch-blob
+pod 'react-native-fetch-blob',
+    :path => '../node_modules/react-native-fetch-blob'
 ```
 
+After `0.10.3` you can install this package directly from Github 
+
+```sh
+# replace <branch_name> with any one of the branches
+npm install --save github:wkh237/react-native-fetch-blob-package#<branch_name>
+```
 **Automatically Link Native Modules**
 
-For 0.29.2+ projects, simply link native packages via following command because rnpm has been merged into react-native, you no longer need it.
+For 0.29.2+ projects, simply link native packages via the following command because rnpm has been merged into react-native, you no longer need it.
 
@@ -88,7 +98,7 @@ ```
 
-The link script might not take effect if you have non-default project structure, please visit [the wiki](https://github.com/wkh237/react-native-fetch-blob/wiki/Manually-Link-Package) to manually link the pacakge.
+The link script might not take effect if you have non-default project structure, please visit [the wiki](https://github.com/wkh237/react-native-fetch-blob/wiki/Manually-Link-Package) to link the package manually.
 
 **Grant Permission to External storage for Android 5.0 or lower**
 
-Mechanism about granting Android permissions has slightly different since Android 6.0 released, please refer to [Official Document](https://developer.android.com/training/permissions/requesting.html).
+The mechanism for granting Android permissions has slightly different since Android 6.0 released, please refer to [Official Document](https://developer.android.com/training/permissions/requesting.html).
 
@@ -124,3 +134,3 @@ If you're going to access external storage (say, SD card storage) for `Android 5.0` (or lower) devices, you might have to add the following line to `AndroidManifest.xml`.
 
-Beginning in Android 6.0 (API level 23), users grant permissions to apps while the app is running, not when they install the app. So adding permissions in `AndroidManifest.xml` won't work in Android 6.0 devices. To grant permissions in runtime, you might use modules like [react-native-android-permissions](https://github.com/lucasferreira/react-native-android-permissions).
+Beginning in Android 6.0 (API level 23), users grant permissions to apps while the app is running, not when they install the app. So adding permissions in `AndroidManifest.xml` won't work for Android 6.0+ devices. To grant permissions in runtime, you might use [PermissionAndroid API](https://facebook.github.io/react-native/docs/permissionsandroid.html).
 
@@ -150,19 +160,19 @@ ## Usage
 
-After `0.8.0` react-native-fetch-blob automatically decide how to send the body by checking its type and `Content-Type` in header. The rule is described in the following diagram
+After `0.8.0` react-native-fetch-blob automatically decide how to send the body by checking its type and `Content-Type` in the header. The rule is described in the following diagram
 
 <img src="img/RNFB-flow (1).png" style="width : 90%" />
 
-To sum up :
+To sum up:
 
-- To send a form data, the `Content-Type` header does not matters. When the body is an `Array` we will set proper content type for you.
+- To send a form data, the `Content-Type` header does not matter. When the body is an `Array` we will set proper content type for you.
 - To send binary data, you have two choices, use BASE64 encoded string or path points to a file contains the body.
  - If the `Content-Type` containing substring`;BASE64` or `application/octet` the given body will be considered as a BASE64 encoded data which will be decoded to binary data as the request body.   
- - Otherwise, if a string starts with `RNFetchBlob-file://` (which can simply done by `RNFetchBlob.wrap(PATH_TO_THE_FILE)`), it will try to find the data from the URI string after `RNFetchBlob-file://` and use it as request body.
+ - Otherwise, if a string starts with `RNFetchBlob-file://` (which can simply be done by `RNFetchBlob.wrap(PATH_TO_THE_FILE)`), it will try to find the data from the URI string after `RNFetchBlob-file://` and use it as the request body.
 - To send the body as-is, simply use a `Content-Type` header not containing `;BASE64` or `application/octet`.
 
-> It is Worth to mentioning that the HTTP request uses cache by default, if you're going to disable it simply add a Cache Control header `'Cache-Control' : 'no-store'`
+> It is Worth to mentioning that the HTTP request uses cache by default, if you're going to disable it simply add a Cache-Control header `'Cache-Control' : 'no-store'`
 
 > After 0.9.4, we disabled `Chunked` transfer encoding by default, if you're going to use it, you should explicitly set header `Transfer-Encoding` to `Chunked`.
 
-### Download example : Fetch files that needs authorization token
+### Download example: Fetch files that need authorization token
 
@@ -207,3 +217,3 @@ Most simple way is download to memory and stored as BASE64 encoded string, this is handy when the response data is small.
   .fetch('GET', 'http://www.example.com/file/example.zip', {
-    some headers ..
+    //some headers ..
   })
@@ -218,3 +228,3 @@ .then((res) => {
 
-Sometimes you might need a file extension for some reason. For example, when using file path as source of `Image` component, the path should end with something like .png or .jpg, you can do this by add `appendExt` option to `config`.
+Sometimes you might need a file extension for some reason. For example, when using file path as the source of `Image` component, the path should end with something like .png or .jpg, you can do this by add `appendExt` option to `config`.
 
@@ -229,3 +239,3 @@ ```js
   .fetch('GET', 'http://www.example.com/file/example.zip', {
-    some headers ..
+    //some headers ..
   })
@@ -243,3 +253,3 @@ .then((res) => {
 
-If you prefer a specific path rather than randomly generated one, you can use `path` option. We've added [several  constants](#user-content-dirs) in v0.5.0 which represents commonly used directories.
+If you prefer a particular file path rather than randomly generated one, you can use `path` option. We've added [several  constants](#user-content-dirs) in v0.5.0 which represents commonly used directories.
 
@@ -266,3 +276,3 @@ ```js
 
-`react-native-fetch-blob` will convert the base64 string in `body` to binary format using native API, this process will be  done in a separated thread, so it won't block your GUI.
+`react-native-fetch-blob` will convert the base64 string in `body` to binary format using native API, this process is done in a separated thread so that it won't block your GUI.
 
@@ -318,7 +328,7 @@ ```js
 
-### Multipart/form-data example : Post form data with file and data
+### Multipart/form-data example: Post form data with file and data
 
 In `version >= 0.3.0` you can also post files with form data, just put an array in `body`, with elements have property `name`, `data`, and `filename`(optional).
 
-Elements have property `filename` will be transformed into binary format, otherwise it turns into utf8 string.
+Elements have property `filename` will be transformed into binary format, otherwise, it turns into utf8 string.
 
@@ -351,3 +361,3 @@ ```js
 
-What if you want to append a file to form data ? Just like [upload a file from storage](#user-content-upload-a-file-from-storage) example, wrap `data` by `wrap` API (this feature is only available for `version >= v0.5.0`). On version >= `0.6.2`, it is possible to set custom MIME type when appending file to form data. But keep in mind when the file is large it's likely crash your app. Please consider use other strategy (see [#94](https://github.com/wkh237/react-native-fetch-blob/issues/94)).
+What if you want to append a file to form data? Just like [upload a file from storage](#user-content-upload-a-file-from-storage) example, wrap `data` by `wrap` API (this feature is only available for `version >= v0.5.0`). On version >= `0.6.2`, it is possible to set custom MIME type when appending a file to form data. But keep in mind when the file is large it's likely to crash your app. Please consider use other strategy (see [#94](https://github.com/wkh237/react-native-fetch-blob/issues/94)).
 
@@ -397,3 +407,3 @@ ```js
   RNFetchBlob.fetch('POST', 'http://www.example.com/upload', {
-      ... some headers,
+      //... some headers,
       'Content-Type' : 'octet-stream'
@@ -417,3 +427,3 @@ }, base64DataString)
 
-In `0.9.6`, you can specify an optional first argument which contains `count` and `interval` to limit progress event frequency (this will be done in native context in order to reduce RCT bridge overhead). Notice that `count` argument will not work if the server does not provide response content length.
+In `0.9.6`, you can specify an object as the first argument which contains `count` and `interval`, to the frequency of progress event (this will be done in the native context a  reduce RCT bridge overhead). Notice that `count` argument will not work if the server does not provide response content length.
 
@@ -423,3 +433,3 @@
   RNFetchBlob.fetch('POST', 'http://www.example.com/upload', {
-      ... some headers,
+      //... some headers,
       'Content-Type' : 'octet-stream'
@@ -445,3 +455,3 @@ }, base64DataString)
 
-After `0.7.0` it is possible to cancel a HTTP request. When the request cancel, it will definately throws an promise rejection, be sure to catch it.
+After `0.7.0` it is possible to cancel an HTTP request. Upon cancellation, it throws a promise rejection, be sure to catch it.
 
@@ -475,3 +485,3 @@ ```js
 
-Media scanner scan the file and categorize by given MIME type, if MIME type not specified, it will try to resolve the file using its file extension.
+Media scanner scans the file and categorizes by given MIME type, if MIME type not specified, it will try to resolve the file using its file extension.
 
@@ -497,3 +507,3 @@ ```js
 
-When download large files on Android it is recommended to use `Download Manager`, it supports lot of native features like progress bar, and notification, also the download task will be handled by OS, and more effective.
+When downloading large files on Android it is recommended to use `Download Manager`, it supports a lot of native features like the progress bar, and notification, also the download task will be handled by OS, and more efficient.
 
@@ -507,3 +517,3 @@ <img src="img/download-manager.png" width="256">
     .config({
-        addAdnroidDownloads : {
+        addAndroidDownloads : {
             useDownloadManager : true, // <-- this is the only thing required
@@ -526,3 +536,3 @@ // Optional, override notification setting (default to true)
 
-**Download Notification and Visibiliy in Download App (Android Only)**
+**Download Notification and Visibility in Download App (Android Only)**
 
@@ -533,3 +543,3 @@ <img src="img/android-notification1.png" width="256">
 
-If you want to display a notification when file's completely download to storage (as the above), or make the downloaded file visible in "Downloads" app. You have to add some options to `config`.
+If you need to display a notification upon the file is downloaded to storage (as the above) or make the downloaded file visible in "Downloads" app. You have to add some options to `config`.
 
@@ -549,3 +559,3 @@ ```js
     // Make the file scannable  by media scanner
-    meidaScannable : true,
+    mediaScannable : true,
   }
@@ -559,5 +569,5 @@ })
 
-This is a new feature added in `0.9.0`, if you're going to open a file path using official [Linking](https://facebook.github.io/react-native/docs/linking.html) API that might not work as expected, also, if you're going to install an APK in `Downloads` app, that will not work too. As an alternative, you can try `actionViewIntent` API, which will send an ACTION_VIEW intent for you which uses the given `MIME` type.
+This is a new feature added in `0.9.0` if you're going to open a file path using official [Linking](https://facebook.github.io/react-native/docs/linking.html) API that might not work as expected, also, if you're going to install an APK in `Downloads` app, that will not function too. As an alternative, you can try `actionViewIntent` API, which will send an ACTION_VIEW intent for you which uses the given `MIME` type.
 
-Download and install an APK programatically
+Download and install an APK programmatically
 
@@ -594,3 +604,3 @@ ```js
 
-File access APIs were made when developing `v0.5.0`, which helping us write tests, and was not planned to be a part of this module. However we realized that, it's hard to find a great solution to manage cached files, every one who use this moudle may need these APIs for there cases.
+File access APIs were made when developing `v0.5.0`, which helping us write tests, and was not planned to be a part of this module. However, we realized that it's hard to find a great solution to manage cached files, everyone who uses this module may need these APIs for their cases.
 
@@ -623,5 +633,5 @@ Before start using file APIs, we recommend read [Differences between File Source](https://github.com/wkh237/react-native-fetch-blob/wiki/File-System-Access-API#differences-between-file-source) first.
 
-In `v0.5.0` we've added  `writeStream` and `readStream`, which allows your app read/write data from file path. This API creates a file stream, rather than convert whole data into BASE64 encoded string, it's handy when processing **large files**.
+In `v0.5.0` we've added  `writeStream` and `readStream`, which allows your app read/write data from the file path. This API creates a file stream, rather than convert entire data into BASE64 encoded string. It's handy when processing **large files**.
 
-When calling `readStream` method, you have to `open` the stream, and start to read data. When the file is large, consider use an appropriate `bufferSize` and `interval` to reduce the native event dispatching overhead (see [Performance Tips](#user-content-performance-tips))
+When calling `readStream` method, you have to `open` the stream, and start to read data. When the file is large, consider using an appropriate `bufferSize` and `interval` to reduce the native event dispatching overhead (see [Performance Tips](#user-content-performance-tips))
 
@@ -631,6 +641,6 @@ ```js
 RNFetchBlob.fs.readStream(
+    // file path
+    PATH_TO_THE_FILE,
     // encoding, should be one of `base64`, `utf8`, `ascii`
     'base64',
-    // file path
-    PATH_TO_THE_FILE,
     // (optional) buffer size, default to 4096 (4095 for BASE64 encoded data)
@@ -655,3 +665,3 @@ // when reading file in BASE64 encoding, buffer size must be multiples of 3.
 
-When use `writeStream`, the stream is also opened immediately, but you have to `write`, and `close` by yourself.
+When using `writeStream`, the stream object becomes writable, and you can then perform operations like `write` and `close`.
 
@@ -675,3 +685,3 @@ ```js
 
-When using `fileCache` or `path` options along with `fetch` API, response data will automatically stored into file system. The files will **NOT** removed unless you `unlink` it. There're several ways to remove the files
+When using `fileCache` or `path` options along with `fetch` API, response data will automatically store into the file system. The files will **NOT** removed unless you `unlink` it. There're several ways to remove the files
 
@@ -697,3 +707,3 @@ ```js
 
-You can also grouping requests by using `session` API, and use `dispose` to remove them all when needed.
+You can also group requests by using `session` API and use `dispose` to remove them all when needed.
 
@@ -734,3 +744,3 @@ ```js
 
-After `0.9.4`, the `Chunked` transfer encoding is disabled by default due to some service provoder may not support chunked transfer. To enable it, set `Transfer-Encoding` header to `Chunked`.
+After `0.9.4`, the `Chunked` transfer encoding is disabled by default due to some service provider may not support chunked transfer. To enable it, set `Transfer-Encoding` header to `Chunked`.
 
@@ -743,3 +753,3 @@ ```js
 
-By default, react-native-fetch-blob does NOT allow connection to unknown certification provider since it's dangerous. If you're going to connect a server with self-signed certification, add `trusty` to `config`. This function is available for version >= `0.5.3`
+By default, react-native-fetch-blob does NOT allow connection to unknown certification provider since it's dangerous. To connect a server with self-signed certification, you need to add `trusty` to `config` explicitly. This function is available for version >= `0.5.3`
 
@@ -767,9 +777,9 @@ ```js
 
-**Read Stream Event Overhead**
+**Read Stream and Progress Event Overhead**
 
-When reading data via `fs.readStream` the process seems blocking JS thread when file is large, it's because the default buffer size is quite small (4kb) which result in large amount of events triggered in JS thread, try to increase the buffer size (for example 100kb = 102400) and set a larger interval (which is introduced in 0.9.4 default value is 10ms) to limit the frequency.
+If the process seems to block JS thread when file is large when reading data via `fs.readStream`.  It might because the default buffer size is quite small (4kb) which result in a lot of events triggered from JS thread. Try to increase the buffer size (for example 100kb = 102400) and set a larger interval (available for 0.9.4+, the default value is 10ms) to limit the frequency.
 
 **Reduce RCT Bridge and BASE64 Overhead**
 
-React Native connects JS and Native context by passing JSON around React Native bridge, and there will be an overhead to convert data before they sent to each side. When data is large, this will be quite a performance impact to your app, it's recommended to use file storage instead of BASE64 if possible.The following chart shows how much faster when loading data from storage than BASE64 encoded string on iphone 6.
+React Native connects JS and Native context by passing JSON around React Native bridge, and there will be an overhead to convert data before they sent to each side. When data is large, this will be quite a performance impact to your app. It's recommended to use file storage instead of BASE64 if possible.The following chart shows how much faster when loading data from storage than BASE64 encoded string on iPhone 6.
 
@@ -784,8 +794,18 @@ <img src="img/performance_1.png" style="width : 100%"/>
 
-**Concate and Replacing Files**
+**Concat and Replacing Files**
 
-If you're going to concatenate files, you don't have to read the data to JS context anymore ! In `0.8.0` we introduced new encoding `uri` for writeFile and appendFile API. Which make it possible to done the whole process in native.
+If you're going to concatenate files, you don't have to read the data to JS context anymore! In `0.8.0` we introduced new encoding `uri` for writeFile and appendFile API, which make it possible to handle the whole process in native.
 
 <img src="img/performance_f2f.png" style="width : 100%"/>
 
+## Caveats
+
+* This library does not urlencode unicode characters in URL automatically, see [#146](https://github.com/wkh237/react-native-fetch-blob/issues/146).
+* When a `Blob` ,  from existing file, the file **WILL BE REMOVE** if you `close` the blob.
+* If you replaced `window.XMLHttpRequest` for some reason (e.g. make Firebase SDK work), it will also affect how official `fetch` works (basically it should work just fine).
+* When file stream and upload/download progress event slow down your app, consider an upgrade to `0.9.6+`, use [additional arguments](https://github.com/wkh237/react-native-fetch-blob/wiki/Fetch-API#fetchprogressconfig-eventlistenerpromisernfetchblobresponse) to limit its frequency.
+* When passing a file path to the library, remove `file://` prefix.
+
+when you got a problem, have a look at [Trouble Shooting](https://github.com/wkh237/react-native-fetch-blob/wiki/Trouble-Shooting) or [issues labeled Trouble Shooting](https://github.com/wkh237/react-native-fetch-blob/issues?utf8=✓&q=label:%22trouble%20shooting%22%20), there'd be some helpful information.
+
 ## Changes
@@ -792,0 +812,0 @@

New alerts

Unidentified License

License

(Experimental) Something that seems like a license was found, but its contents could not be matched with a known license.

Found 1 instance in 1 package

Fixed alerts

Unidentified License

License

(Experimental) Something that seems like a license was found, but its contents could not be matched with a known license.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

2632041

increased by426.12%

Number of package files

92

increased by10.84%

Number of lines in readme file

785

increased by2.61%

Worsened metrics

Lines of code

4798

decreased by-34.85%

No dependency changes