| title | Download a blob with JavaScript or TypeScript |
|---|---|
| titleSuffix | Azure Storage |
| description | Learn how to download a blob in Azure Storage by using the JavaScript client library. |
| services | storage |
| author | stevenmatthew |
| ms.author | shaas |
| ms.date | 10/28/2024 |
| ms.service | azure-blob-storage |
| ms.topic | how-to |
| ms.devlang | javascript |
| ms.custom | devx-track-js, devguide-js, devx-track-ts, devguide-ts |
[!INCLUDE storage-dev-guide-selector-download]
This article shows how to download a blob using the Azure Storage client library for JavaScript. You can download blob data to various destinations, including a local file path, stream, or text string.
- The examples in this article assume you already have a project set up to work with the Azure Blob Storage client library for JavaScript. To learn about setting up your project, including package installation, importing modules, and creating an authorized client object to work with data resources, see Get started with Azure Blob Storage and JavaScript.
- The authorization mechanism must have permissions to perform a download operation. To learn more, see the authorization guidance for the following REST API operation:
You can use any of the following methods to download a blob:
- BlobClient.download
- BlobClient.downloadToBuffer (only available in Node.js runtime)
- BlobClient.downloadToFile (only available in Node.js runtime)
The following example downloads a blob by using a file path with the BlobClient.downloadToFile method. This method is only available in the Node.js runtime:
:::code language="javascript" source="~/azure-storage-snippets/blobs/howto/JavaScript/NodeJS-v12/dev-guide/download-blob-to-file.js" id="snippet_downloadBlobToFile":::
:::code language="typescript" source="~/azure-storage-snippets/blobs/howto/TypeScript/NodeJS-v12/dev-guide/src/blob-download-to-file.ts" id="snippet_downloadBlobToFile":::
The following example downloads a blob by creating a Node.js writable stream object and then piping to that stream with the BlobClient.download method.
:::code language="javascript" source="~/azure-storage-snippets/blobs/howto/JavaScript/NodeJS-v12/dev-guide/download-blob-to-stream.js" id="snippet_downloadBlobAsStream":::
:::code language="typescript" source="~/azure-storage-snippets/blobs/howto/TypeScript/NodeJS-v12/dev-guide/src/blob-download-to-stream.ts" id="snippet_downloadBlobAsStream":::
The following Node.js example downloads a blob to a string with BlobClient.download method. In Node.js, blob data returns in a readableStreamBody.
:::code language="javascript" source="~/azure-storage-snippets/blobs/howto/JavaScript/NodeJS-v12/dev-guide/download-blob-to-string.js" id="snippet_downloadBlobToString":::
:::code language="typescript" source="~/azure-storage-snippets/blobs/howto/TypeScript/NodeJS-v12/dev-guide/src/blob-download-to-string.ts" id="snippet_downloadBlobToString":::
If you're working with JavaScript in the browser, blob data returns in a promise blobBody. To learn more, see the example usage for browsers at BlobClient.download.
To learn more about how to download blobs using the Azure Blob Storage client library for JavaScript, see the following resources.
View code samples from this article (GitHub):
-
Download to file for JavaScript or TypeScript
-
Download to stream for JavaScript or TypeScript
-
Download to string for JavaScript or TypeScript
The Azure SDK for JavaScript contains libraries that build on top of the Azure REST API, allowing you to interact with REST API operations through familiar JavaScript paradigms. The client library methods for downloading blobs use the following REST API operation:
- Get Blob (REST API)
[!INCLUDE storage-dev-guide-resources-javascript]
[!INCLUDE storage-dev-guide-next-steps-javascript]