(Node.js) REST Asynchronous Streaming Upload File

See more REST Examples

Demonstrates how to asynchronous streaming upload a file to cloud storage. This particular example demonstrates an upload to the Azure Cloud Storage service. The same concepts apply to S3, Google Cloud, and Google Drive.

Install Chilkat for Node.js and Electron using npm at Chilkat npm packages for Node.js Chilkat npm packages for Electron on Windows, Linux, MacOSX, and ARM

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}

function chilkatExample() {

    // This example requires the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    var rest = new chilkat.Rest();

    // Connect to the Azure Storage Blob Service
    var bTls = true;
    var port = 443;
    var bAutoReconnect = true;
    // In this example, the storage account name is "chilkat".
    var success = rest.Connect("chilkat.blob.core.windows.net",port,bTls,bAutoReconnect);
    if (success !== true) {
        console.log(rest.LastErrorText);
        return;
    }

    // Provide Azure Cloud credentials for the REST call.
    var azAuth = new chilkat.AuthAzureStorage();
    azAuth.AccessKey = "AZURE_ACCESS_KEY";
    // The account name used here should match the 1st part of the domain passed in the call to Connect (above).
    azAuth.Account = "chilkat";
    azAuth.Scheme = "SharedKey";
    azAuth.Service = "Blob";
    // This causes the "x-ms-version: 2021-08-06" header to be automatically added.
    azAuth.XMsVersion = "2021-08-06";
    success = rest.SetAuthAzureStorage(azAuth);

    // Set some request headers.
    success = rest.AddHeader("x-ms-blob-content-disposition","attachment; filename=\"thisIsATest.txt\"");
    success = rest.AddHeader("x-ms-blob-type","BlockBlob");
    success = rest.AddHeader("x-ms-meta-m1","v1");
    success = rest.AddHeader("x-ms-meta-m2","v2");

    // Note: The application does not need to explicitly set the following
    // headers: x-ms-date, Authorization, and Content-Length.  These headers
    // are automatically set by Chilkat.

    var sendStream = new chilkat.Stream();

    // Define the source data for the stream to be a file.
    sendStream.SourceFile = "qa_data/hamlet.xml";

    // Create a background thread task to upload from the stream
    // The name of the Azure storage container is "test".
    // task: Task
    var task = rest.FullRequestStreamAsync("PUT","/test/thisIsATest.txt",sendStream);

    // Start the task. 
    success = task.Run();

    // In this example, we'll simply sleep and periodically
    // check to see if the REST upload if finished.
    var curPctDone = 0;
    while (task.Finished !== true) {
        task.SleepMs(100);
    }

    // Check to see if the call to FullRequestStream in the background thread pool succeeded.
    if (task.TaskSuccess !== true) {
        // Show what would've been the LastErrorText had FullRequestStream been called synchronously
        console.log(task.ResultErrorText);

        return;
    }

    var responseStatusCode = rest.ResponseStatusCode;

    // When successful, the Azure Storage service will respond with a 201 response code,
    // with an empty body.  Therefore, in the success condition, the responseStr is empty.
    if (responseStatusCode == 201) {
        console.log("File uploaded.");
    }
    else {
        // It failed, so examine the response body, if one was returned:
        // Given that FullRequestStream returns a string, the return value is obtained via GetResultString.
        var responseBodyStr = task.GetResultString();
        console.log("response body (if any): " + responseBodyStr);

        // Examine the request/response to see what happened.
        console.log("response status code = " + rest.ResponseStatusCode);
        console.log("response status text = " + rest.ResponseStatusText);
        console.log("response header: " + rest.ResponseHeader);
        console.log("---");
        console.log("LastRequestStartLine: " + rest.LastRequestStartLine);
        console.log("LastRequestHeader: " + rest.LastRequestHeader);
    }


}

chilkatExample();