@fundwave/fetchq

A client-side library that allows you to queue fetch requests.

• Supports ES modules
• Supports CommonJS

Installation

npm install @fundwave/fetchq

Initialization

import { FetchQueue } from "@fundwave/fetchq";

const MyFetchQueue = new FetchQueue({ concurrent: 2 });
// returns custom fetch function with queueing enabled.
const fetch = MyFetchQueue.getFetchMethod();

Options

| Property | Description | Default Value | | ----------------- | ------------------------------------- | -------------- | | concurrent | number of concurrent fetch requests | 3 | | pauseQueueOnInit | start queue with a paused state | false | | pre | array of configs for pre-fetch-hooks | [] | | queuingPatterns | array of regex to queue matching requests | [] | | debug | set debug mode | false | | keyBuilderParams | to build a unique key for queue | ["url", "options.method", "options.body"] |

Usage

import { FetchQueue } from "@fundwave/fetchq";

const fetchQueue = new FetchQueue(); // concurent defaults to 3
const customFetch = fetchQueue.getFetchMethod();

const urls = [...]
const options = {...}

const promises = urls.map(async (url) => await customFetch(url, options))
const responses = await Promise.all(promises);

// get queue length at real time
console.log(fetchQueue.getQueueLength());

// getters and setters
fetchQueue.setConcurrent(5);
console.log(fetchedQueue.getConcurrent()); // output: 5

fetchQueue.setDebug(true);
console.log(fetchedQueue.getDebug()); // output: true

// start and pause queue
const fetchQueue = new FetchQueue(concurrent: 3, pauseQueueOnInit: true);
const customFetch = fetchQueue.getFetchMethod();

// ...some calls
fetchQueue.emptyQueue();
fetchQueue.startQueue();

// ...some calls
fetchQueue.pauseQueue();

Note: See DOCUMENTATION.md for more information on methods.