hd-utils/lib/utils/browser/networkHttpRequestMonitor.d.ts

A handy utils for modern JS developers

import { NetworkHttpRequestMonitorOptions, NetworkRequestList } from '../types';
/**
 *
 * @description --Browser only -- a function that takes onRequestsIdle to be executed when the network becomes idle, which means no active network requests (like XHR or Fetch API) are ongoing.
 * @example
 * `// Usage
const cancel = networkHttpRequestMonitor((startedRequests, endedRequests) => {
    console.log('Network is now idle.');
}, (startedRequests, endedRequests, activeRequestsCount)=>{
console.log("THIS WILL BE CALLED ON EVERY NETWORK REQUEST", {startedRequests, endedRequests, activeRequestsCount})
});

// to cancel
cancel();`
 */
export default function networkHttpRequestMonitor(onRequestsIdle?: (startedRequests: NetworkRequestList, endedRequests: NetworkRequestList) => void, onEachRequest?: (startedRequests: NetworkRequestList, endedRequests: NetworkRequestList, activeRequestsCount: number) => void, options?: NetworkHttpRequestMonitorOptions): () => void;