Help Center> Object Storage Service> SDK Reference> BrowserJS> Object Download> Obtaining Download Progresses
View PDF

Obtaining Download Progresses

If you have any questions during development, post them on the Issues page of GitHub. For details about parameters and usage of each API, see the API Reference.

You can set the callback function to obtain download progress. Sample code is as follows:

// Create an instance of ObsClient.
var obsClient = new ObsClient({
    access_key_id: '*** Provide your Access Key ***',       
    secret_access_key: '*** Provide your Secret Key ***',       
    server : 'https://your-endpoint'
});

var callback = function(transferredAmount, totalAmount, totalSeconds){
    // Obtain the average download rate (KB/s).
    console.log(transferredAmount * 1.0 / totalSeconds / 1024);
    // Obtain the download progress in percentage.
    console.log(transferredAmount * 100.0 / totalAmount);
};

obsClient.getObject({
       Bucket : 'bucketname',
       Key : 'objectname',
       ProgressCallback: callback 
}, function (err, result) {
       if(err){
              console.error('Error-->' + err);
       }else{
              console.log('Status-->' + result.CommonMsg.Status);
              if(result.CommonMsg.Status < 300 && result.InterfaceResult){
                   // Obtain the object content.
                   console.log('Object Content:'); 
                   console.log(result.InterfaceResult.Content); 
              }
       }
});

Only text-based and binary download support obtaining the download progress.

Parent topic: Object Download