feat: add support for reachabilityMethod to specify GET or HEAD (#610)

README.md

@@ -220,7 +220,8 @@ The configuration options for the library.
 
 | Property | Type | Default | Description
 | ---------------------------- | --------------------------------- | ----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | 
-| `reachabilityUrl`            | `string`                          | `https://clients3.google.com/generate_204` | The URL to call to test if the internet is reachable. Only used on platforms which do not supply internet reachability natively or if `useNativeReachability` is `false`.                                                                                                          |
+| `reachabilityUrl`            | `string`                          | `https://clients3.google.com/generate_204` | The URL to call to test if the internet is reachable. Only used on platforms which do not supply internet reachability natively or if `useNativeReachability` is `false`.           
+| `reachabilityMethod`            | `NetInfoMethodType`                          | `HEAD` | The HTTP request method to use to call reachabilityUrl URL to call to test if the internet is reachable. Defaults to `HEAD`. `GET` is also available                                                                                               |
 | `reachabilityTest`           | `(response: Response) => boolean` | `Promise.resolve(response.status === 204)` | A function which is passed the `Response` from calling the reachability URL. It should return `true` if the response indicates that the internet is reachable. Only used on platforms which do not supply internet reachability natively or if `useNativeReachability` is `false`. |
 | `reachabilityShortTimeout`   | `number`                          | 5 seconds | The number of milliseconds between internet reachability checks when the internet was not previously detected. Only used on platforms which do not supply internet reachability natively or if `useNativeReachability` is `false`.                                                 |
 | `reachabilityLongTimeout`    | `number`                          | 60 seconds | The number of milliseconds between internet reachability checks when the internet was previously detected. Only used on platforms which do not supply internet reachability natively or if `useNativeReachability` is `false`.                                                     |

src/internal/defaultConfiguration.ts

@@ -2,6 +2,7 @@ import * as Types from './types';
 
 const DEFAULT_CONFIGURATION: Types.NetInfoConfiguration = {
   reachabilityUrl: 'https://clients3.google.com/generate_204',
+  reachabilityMethod: 'HEAD',
   reachabilityTest: (response: Response): Promise<boolean> =>
     Promise.resolve(response.status === 204),
   reachabilityShortTimeout: 5 * 1000, // 5s

src/internal/defaultConfiguration.web.ts

@@ -2,6 +2,7 @@ import * as Types from './types';
 
 const DEFAULT_CONFIGURATION: Types.NetInfoConfiguration = {
   reachabilityUrl: '/',
+  reachabilityMethod: "HEAD",
   reachabilityTest: (response: Response): Promise<boolean> =>
     Promise.resolve(response.status === 200),
   reachabilityShortTimeout: 5 * 1000, // 5s

src/internal/internetReachability.ts

@@ -7,8 +7,8 @@
  * @format
  */
 
-import * as Types from './types';
 import * as PrivateTypes from './privateTypes';
+import * as Types from './types';
 
 interface InternetReachabilityCheckHandler {
   promise: Promise<void>;
@@ -69,7 +69,7 @@ export default class InternetReachability {
 
   private _checkInternetReachability = (): InternetReachabilityCheckHandler => {
     const responsePromise = fetch(this._configuration.reachabilityUrl, {
-      method: 'HEAD',
+      method: this._configuration.reachabilityMethod,
       cache: 'no-cache',
     });
 

src/internal/types.ts

@@ -19,6 +19,8 @@ export enum NetInfoStateType {
   other = 'other',
 }
 
+export type NetInfoMethodType = 'HEAD' | 'GET';
+
 export enum NetInfoCellularGeneration {
   '2g' = '2g',
   '3g' = '3g',
@@ -109,6 +111,7 @@ export type NetInfoSubscription = () => void;
 
 export interface NetInfoConfiguration {
   reachabilityUrl: string;
+  reachabilityMethod?: NetInfoMethodType;
   reachabilityTest: (response: Response) => Promise<boolean>;
   reachabilityLongTimeout: number;
   reachabilityShortTimeout: number;