@react-native-community/netinfo/src/internal/privateTypes.ts

React Native Network Info API for iOS & Android

/**
 * Copyright (c) Facebook, Inc. and its affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *
 * @format
 */

import {NetInfoConfiguration, NetInfoState} from './types';

export const DEVICE_CONNECTIVITY_EVENT = 'netInfo.networkStatusDidChange';

// Certain properties are optional when sent by the native module and are handled by the JS code
export type NetInfoNativeModuleState = Pick<
  NetInfoState,
  Exclude<keyof NetInfoState, 'isInternetReachable'>
> & {isInternetReachable?: boolean};

export interface Events {
  [DEVICE_CONNECTIVITY_EVENT]: NetInfoNativeModuleState;
}

export interface NetInfoNativeModule {
  configure: (config: Partial<NetInfoConfiguration>) => void;
  getCurrentState: (
    requestedInterface?: string,
  ) => Promise<NetInfoNativeModuleState>;
  addListener<K extends keyof Events>(
    type: K,
    listener: (event: Events[K]) => void,
  ): void;
  removeListeners<K extends keyof Events>(
    type: K,
    listener: (event: Events[K]) => void,
  ): void;
}

export type NetInfoInternetReachabilityChangeListener = (
  isInternetReachable: boolean | null | undefined,
) => void;