feat: add optional reachabilityHeaders param to NetInfoConfiguration (react-native-netinfo#673)

Author: webraptor

README.md

@@ -224,6 +224,7 @@ 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`. 
+| `reachabilityHeaders` | `object` | `{}` | A HTTP headers object, an object literal, or an array of two-item arrays to set request's headers, to use during the reachabilityUrl URL call to test if the internet is reachable. Defaults to `{}`. |
 | `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`. |

src/internal/defaultConfiguration.ts

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

src/internal/defaultConfiguration.web.ts

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

src/internal/internetReachability.ts

@@ -69,6 +69,7 @@ export default class InternetReachability {
 
  private _checkInternetReachability = (): InternetReachabilityCheckHandler => {
  const responsePromise = fetch(this._configuration.reachabilityUrl, {
+ headers: this._configuration.reachabilityHeaders,
  method: this._configuration.reachabilityMethod,
  cache: 'no-cache',
  });

src/internal/types.ts

@@ -117,6 +117,7 @@ export type NetInfoSubscription = () => void;
 export interface NetInfoConfiguration {
  reachabilityUrl: string;
  reachabilityMethod?: NetInfoMethodType;
+ reachabilityHeaders?: HeadersInit;
  reachabilityTest: (response: Response) => Promise<boolean>;
  reachabilityLongTimeout: number;
  reachabilityShortTimeout: number;