status-im
/
react-native
mirror of https://github.com/status-im/react-native.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add comments on NetInfo.js 

Summary:
Further describe the methods available on NetInfo.

Question: How do I update the docs on the website?
Closes https://github.com/facebook/react-native/pull/7375

Differential Revision: D3303300

fbshipit-source-id: 4343d490f65e4e47b93f2c98a645cb675d2cf708
This commit is contained in:
Yao Bin Then 2016-05-14 18:42:55 -07:00 committed by Facebook Github Bot 2
parent e34c9c4e5f
commit 433c0e8021
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
Libraries/Network/NetInfo.js
View File

@ -168,6 +168,10 @@ const _isConnectedSubscriptions = new Map();
* ```
*/
const NetInfo = {
/**
* Invokes the listener whenever network status changes.
* The listener receives one of the connectivity types listed above.
*/
addEventListener(
eventName: ChangeEventName,
handler: Function
@ -184,6 +188,9 @@ const NetInfo = {
};
},
/**
* Removes the listener for network status changes.
*/
removeEventListener(
eventName: ChangeEventName,
handler: Function
@ -196,10 +203,20 @@ const NetInfo = {
_subscriptions.delete(handler);
},
/**
* Returns a promise that resolves with one of the connectivity types listed
* above.
*/
fetch(): Promise {
return RCTNetInfo.getCurrentConnectivity().then(resp => resp.network_info);
},
/**
* An object with the same methods as above but the listener receives a
* boolean which represents the internet connectivity.
* Use this if you are only interested with whether the device has internet
* connectivity.
*/
isConnected: {
addEventListener(
eventName: ChangeEventName,