ssap_app/node_modules/@react-native-community/netinfo/lib/module/index.js

195 lines
5.5 KiB
JavaScript

/**
* 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 { useState, useEffect, useCallback } from 'react';
import { Platform } from 'react-native';
import DEFAULT_CONFIGURATION from './internal/defaultConfiguration';
import NativeInterface from './internal/nativeInterface';
import State from './internal/state';
import * as Types from './internal/types'; // Stores the currently used configuration
let _configuration = DEFAULT_CONFIGURATION; // Stores the singleton reference to the state manager
let _state = null;
const createState = () => {
return new State(_configuration);
}; // Track ongoing requests
let isRequestInProgress = false;
let requestQueue = [];
/**
* Configures the library with the given configuration. Note that calling this will stop all
* previously added listeners from being called again. It is best to call this right when your
* application is started to avoid issues. The configuration sets up a global singleton instance.
*
* @param configuration The new configuration to set.
*/
export function configure(configuration) {
_configuration = { ...DEFAULT_CONFIGURATION,
...configuration
};
if (_state) {
_state.tearDown();
_state = createState();
}
if (Platform.OS === 'ios') {
NativeInterface.configure(configuration);
}
}
/**
* Returns a `Promise` that resolves to a `NetInfoState` object.
* This function operates on the global singleton instance configured using `configure()`
*
* @param [requestedInterface] interface from which to obtain the information
*
* @returns A Promise which contains the current connection state.
*/
export function fetch(requestedInterface) {
if (!_state) {
_state = createState();
}
return _state.latest(requestedInterface);
}
/**
* Force-refreshes the internal state of the global singleton managed by this library.
*
* @returns A Promise which contains the updated connection state.
*/
export function refresh() {
if (!_state) {
_state = createState();
} // If a request is already in progress, return a promise that will resolve when the current request finishes
if (isRequestInProgress) {
return new Promise(resolve => {
requestQueue.push(resolve);
});
}
isRequestInProgress = true;
return _state._fetchCurrentState().then(result => {
requestQueue.forEach(resolve => resolve(result));
requestQueue = [];
return result;
}).finally(() => {
isRequestInProgress = false;
});
}
/**
* Subscribe to the global singleton's connection information. The callback is called with a parameter of type
* [`NetInfoState`](README.md#netinfostate) whenever the connection state changes. Your listener
* will be called with the latest information soon after you subscribe and then with any
* subsequent changes afterwards. You should not assume that the listener is called in the same
* way across devices or platforms.
*
* @param listener The listener which is called when the network state changes.
*
* @returns A function which can be called to unsubscribe.
*/
export function addEventListener(listener) {
if (!_state) {
_state = createState();
}
_state.add(listener);
return () => {
_state && _state.remove(listener);
};
}
/**
* A React Hook into this library's singleton which updates when the connection state changes.
*
* @param {Partial<Types.NetInfoConfiguration>} configuration - Configure the isolated network checker managed by this hook
*
* @returns The connection state.
*/
export function useNetInfo(configuration) {
if (configuration) {
configure(configuration);
}
const [netInfo, setNetInfo] = useState({
type: Types.NetInfoStateType.unknown,
isConnected: null,
isInternetReachable: null,
details: null
});
useEffect(() => {
const unsubscribe = addEventListener(setNetInfo);
return () => unsubscribe();
}, []);
return netInfo;
}
/**
* A React Hook which manages an isolated instance of the network info manager.
* This is not a hook into a singleton shared state. NetInfo.configure, NetInfo.addEventListener,
* NetInfo.fetch, NetInfo.refresh are performed on a global singleton and have no affect on this hook.
* @param {boolean} isPaused - Pause the internal network checks.
* @param {Partial<Types.NetInfoConfiguration>} configuration - Configure the isolated network checker managed by this hook
*
* @returns the netInfo state and a refresh function
*/
export function useNetInfoInstance(isPaused = false, configuration) {
const [networkInfoManager, setNetworkInfoManager] = useState();
const [netInfo, setNetInfo] = useState({
type: Types.NetInfoStateType.unknown,
isConnected: null,
isInternetReachable: null,
details: null
});
useEffect(() => {
if (isPaused) {
return;
}
const config = { ...DEFAULT_CONFIGURATION,
...configuration
};
const state = new State(config);
setNetworkInfoManager(state);
state.add(setNetInfo);
return state.tearDown;
}, [isPaused, configuration]);
const refresh = useCallback(() => {
if (networkInfoManager && !isRequestInProgress) {
isRequestInProgress = true;
networkInfoManager._fetchCurrentState().finally(() => {
isRequestInProgress = false;
});
}
}, [networkInfoManager]);
return {
netInfo,
refresh
};
}
export * from './internal/types';
export default {
configure,
fetch,
refresh,
addEventListener,
useNetInfo,
useNetInfoInstance
};
//# sourceMappingURL=index.js.map