@masvio/uploader v2.1.2

MASV Web Uploader

Installation

yarn add @masvio/web-uploader

Usage

Module

import { Uploader } from "@masvio/uploader";

const uploader = new Uploader(
    packageID,
    packageToken,
    apiURL,
);

IIFE (Legacy)

Include the uploader library in your page:

<script type="text/javascript" src="<path-to-uploader>/index.iife.js"></script>

const uploader = new MASV.Uploader(
    packageID,
    packageToken,
    apiURL,
);

API Reference

Constructor

new Uploader(packageID, packageToken, apiURL)

Methods

• setListener
• upload
• terminate

setListener

Add listeners to different events broadcast by the uploader:

uploader.setListener({
    onProgress: (completed, total, speed) => {},
    onFileComplete: (file) => {},
    onRetry: (reason) => {},
    onComplete: () => {},
    onError: (error) => {},
});

The events and their callback parameters are defined below:

onProgress

Upload progress occurs (bytes getting uploaded). It reports completed bytes so far, and total byte size of all files.

Please note that the progress is not necessarily monotonic. As the uploader processes chunks, it reports the progress inclusive of chunks that are in flight. In the event of a retry due to a retriable error, it resets the progress to the previous value prior to uploading the chunk since chunks have to be uploaded entirely. It's up to you to handle this behaviour in the UI.

onFileComplete

One of the supplied files finishes uploading, it indicates which file object was completed

onRetry

The uploader retries a request (for example a file chunk upload) due to an error that is deemed retriable by the uploader (for example, a network error or a 5xx server error)

onComplete

The upload is completed and the package have been finalized

onError

An unrecoverable error has occurred and the upload halted (for example, a 401 server error is considered unrecoverable)

upload

Upload a collection of MasvFiles

uploader.upload([
    {
        id,
        file,
        path,
    },
]);

MasvFile

terminate

Cancel your current upload

uploader.terminate();