fetch-chunk v2.4.0

fetch-chunk

This module is an extension of the browser fetch function, allowing us to process incoming data in chunks instead of waiting for the full fetch to complete.

Installation

fetch-chunk has no dependencies, but it only works on browsers with async/await support.

Simply install fetch-chunk using npm:

npm install fetch-chunk

Then, you can import it on your project using the following code:

import fetchChunk from "fetch-chunk";

//OR

const fetchChunk = require("fetch-chunk");

If you want to use a script tag, you need to include the fetch-chunk.browser.js file, like so:

<script src="fetch-chunk.browser.js"></script>

The fetchChunk function will then be available in the browser's window object.

Usage

The fetchChunk(url, opts) function has the same signature and behavior as the standard fetch(url, opts) function, but the opts object can accept an additional callback function named onProgress that is called regularly as the data comes in. This callback takes two arguments: data and progress. data contains the chunk of data in Uint8Array format. progress is a JS object with two properties, contentLength and transferredLength, both integers representing the amount of bytes transferred, as integers. Note that the incoming data is not cumulative, meaning that each call of onProgress will contain just that particular chunk that has arrived, not all the data so far.

Example

fetchChunk("url/to/big/file.mp4", {
    onProgress:(data, progress) => {
    let transferPercentage = progress.transferredLength / progress.contentLength; 
    // process the data here.
    // data is a Uint8Array object
    // progress is object of form {contentLength, transferredLength}
    }
});

License: MIT