A utility for fetching large files in chunks with support for parallel downloads, progress tracking, and request abortion.
Install the package using npm:
npm install fetch-in-chunksimport fetchInChunks from 'fetch-in-chunks';async function fetchInchunks(url, options = {})url(string): The URL of the file to download.options(object, optional): An object containing additional options.options.chunkSize(number, optional): The size of each chunk to download in bytes. Defaults to the total file size divided bymaxParallelRequests.options.maxParallelRequests(number, default: '6'): The number of chunks to download in parallel.options.progressCallback(function, optional): A callback function that will be called with the number of bytes downloaded and the total size of the file.options.signal(AbortSignal, optional): AnAbortSignalobject that can be used to abort the download.
Promise<Blob>: A promise that resolves to aBlobcontaining the downloaded file.
import fetchInChunks from 'fetch-in-chunks';
async function downloadFile() {
try {
const blob = await fetchInChunks('https://example.com/largefile.zip');
return blob;
} catch (error) {
console.error('Error fetching file:', error);
}
}
downloadFile();import fetchInChunks from 'fetch-in-chunks';
async function downloadFileWithProgress() {
try {
const blob = await fetchInChunks('https://example.com/largefile.zip', {
progressCallback: (downloaded, total) => {
console.log(`Downloaded ${((downloaded / total) * 100).toFixed(2)}%`);
},
});
return blob;
} catch (error) {
console.error('Error fetching file:', error);
}
}
downloadFileWithProgress();import fetchInChunks from 'fetch-in-chunks';
async function downloadFileWithAbort() {
const controller = new AbortController();
const signal = controller.signal;
try {
const blob = await fetchInChunks('https://example.com/largefile.zip', {
signal,
});
return blob;
} catch (error) {
if (error.name === 'AbortError') {
console.log('Download aborted');
} else {
console.error('Error fetching file:', error);
}
}
// You can abort the download at any time.
setTimeout(() => {
controller.abort();
}, 10_000);
}This project is licensed under the Apache 2.0 License. See the LICENSE file
for details.