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.

This example downloads objectname from bucketname and uses ProgressCallback to monitor the download progress.

The example code is as follows:

// Create an instance of ObsClient.
var obsClient = new ObsClient({
    // Hard-coded or plaintext AK/SK are risky. For security purposes, encrypt your AK/SK and store them in the configuration file or environment variables. In this example, the AK/SK are stored in environment variables for identity authentication. Before running this example, configure environment variables AccessKeyID and SecretAccessKey.
    // The front-end code does not have the process environment variable, so you need to use a module bundler like webpack to define the process variable.
    // Obtain an AK/SK pair on the management console. For details, see https://support.huaweicloud.com/intl/en-us/usermanual-ca/ca_01_0003.html.
    access_key_id: process.env.AccessKeyID,
    secret_access_key: process.env.SecretAccessKey,
    // Replace the example endpoint with the actual one in your case.
    server: 'https://obs.ap-southeast-1.myhuaweicloud.com'
});

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.