box-node-sdk

Downloads

Downloads module is used to download files from Box.

• Downloads
  • Download a File
  • Get download URL
    • Arguments
    • Returns

Download a File

To get the entire contents of the file as ArrayBuffer, call downloadFile method. This method returns a ArrayBuffer object which contains the file content.

const fs = require('fs');

const fileContent = await client.downloads.downloadFile('123456789');
const fileWriteStream = fs.createWriteStream('file.pdf');
fileContent.pipe(fileWriteStream);

Get download URL

Get a URL to download a file

This operation is performed by calling function getDownloadFileUrl.

await client.downloads.getDownloadFileUrl(uploadedFile.id);

Arguments

• fileId string
  • The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123. Example: “12345”

• optionalsInput GetDownloadFileUrlOptionalsInput

Returns

This function returns a value of type string.

This site is open source. Improve this page.