[v5] Cusomisation options & removal of deprecated methods

[matt-oakes]

Overview

This PR is for the future 5.0.0 release. The main changes are:

• Removal of the methods which has been deprecated and undocumented since 2.0.0. These were the original method names from when this library was part of the React Native core.
• Allow the internet reachability test to be customised to allow this library to work in all locations.

Breaking changes:

• Deprecated methods have been removed.
• The library will not begin monitoring the internet connectivity state until the first time you call a method. This may change the results you get when calling fetch().

How to test this

yarn add @react-native-community/netinfo@next

or

npm install --save @react-native-community/netinfo@next

Please report back if this PR is working well for you. If you have any issues, open a new issue with [v5] at the start of the issue title.

Fixes #201

Fixes #147

[mwmcode]

I think this should be an async/await function
reachabilityTest: async response => await response.status === 204,
because TS is complaining "Type 'boolean' is not assignable to type 'Promise'.ts(2322)"

[mwmcode]

@matt-oakes I just tried changing the useNetInfo hook to accept user config and it seems to work.

export function useNetInfo(
  userConfig?: Partial<Types.NetInfoConfiguration>,
): Types.NetInfoState {
  if (userConfig) {
    configure(userConfig);
  }
  // ... same code
  const [netInfo, setNetInfo] = useState<Types.NetInfoState>({
    type: Types.NetInfoStateType.unknown,
    isConnected: false,
    isInternetReachable: false,
    details: null,
  });

  useEffect((): (() => void) => {
    return addEventListener(setNetInfo);
  }, []);

  return netInfo;
}

In my app

export default function OtherScreen() {
  const { isConnected, type } = useNetInfo({
    reachabilityUrl: 'http://detectportal.firefox.com',
    reachabilityTest: async response => (await response.text()) === 'success',
  });
....
}

• Not sure if this is the right place for this comment, if it is not please advise
• If user finds it "ugly" to pass an object to the hook, they can always create a custom one
• They way I "know" it works, is because my firewall app is showing a warning that the app is trying to reach http://detectportal.firefox.com instead of google one
• Thoughts?

[MrLoh]

this looks really good, any idea on when this might be released?

[matt-oakes]

I still need to do some work on this before I can release it. See the list above for details.

[xiqi]

Suggested change

	reachabilityShortTimeout: 60 * 1000, // 60s
	reachabilityShortTimeout: 5 * 1000, // 5s

[xiqi]

Suggested change

	reachabilityLongTimeout: 5 * 1000, // 5s
	reachabilityLongTimeout: 60 * 1000, // 60s

[react-native-community-bot]

🎉 This PR is included in version 5.0.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀