4.9 KiB
Azure Storage JavaScript Client Library for Browsers
- Join the community discussion on Slack!
Downloading
It's recommended to use the Azure Storage JavaScript Client Library provided by us. Please download the latest library.
There are 8 generated JavaScript files for Azure Storage JavaScript Client Library:
azure-storage.blob.jsandazure-storage.blob.min.jscontain the Azure Storage blob service operation logicazure-storage.table.jsandazure-storage.table.min.jscontain the Azure Storage table service operation logicazure-storage.queue.jsandazure-storage.queue.min.jscontain the Azure Storage queue service operation logicazure-storage.file.jsandazure-storage.file.min.jscontain the Azure Storage file service operation logic
We also provide samples to guide you quickly start with the Azure Storage JavaScript Client Library. In the JavaScript Client Library zip file or following online links, you will find 4 HTML samples:
- sample-blob.html demonstrates how to operate with Azure Storage blob service in the browser
- sample-table.html demonstrates how to operate with Azure Storage table service in the browser
- sample-queue.html demonstrates how to operate with Azure Storage queue service in the browser
- sample-file.html demonstrates how to operate with Azure Storage file service in the browser
After generating the JavaScript Client Library, you can try the samples in browsers such as Chrome/Edge/Firefox directly.
Note: An HTTP server should be set to host the samples for IE browser.
Or you can directly try with following online samples:
Module Support
Above JavaScript files are all UMD compatible. You can load them in a CommonJS or AMD environment by JavaScript module loaders. If no module system is found, following global variables will be set:
AzureStorage.BlobAzureStorage.TableAzureStorage.QueueAzureStorage.File
Compatibility
Compatibility with mobile browsers have not been fully validated, please open issues when you get errors.
Generating a Custom Azure Storage JavaScript Client Library
If you wish to customize the library and generate the Azure Storage JavaScript Client Library, you can follow the following steps.
We provide browserify bundle scripts which generate Azure Storage JavaScript Client Library. The bundle script reduces the size of the Storage Client Library by splitting into smaller files, one per storage service.
The generated JavaScript Client Library includes 8 separated JavaScript files:
azure-storage.blob.jsazure-storage.table.jsazure-storage.queue.jsazure-storage.file.jsazure-storage.blob.min.jsazure-storage.table.min.jsazure-storage.queue.min.jsazure-storage.file.min.js
Let's get started to generate the Azure Storage JavaScript Client Library!
Step 1: Cloning Repo
Azure Storage JavaScript Client Library is generated from Azure Storage SDK for Node.js. Clone azure-storage-node repo with following command:
git clone https://github.com/Azure/azure-storage-node.git
Step 2: Installing Node.js Modules
Change to the root directory of the cloned repo:
cd azure-storage-node
Install the dependent Node.js modules:
npm install
Step 3: Generating JavaScript Client Library with Bundle Scripts
We provide bundle scripts to help quickly generate the JavaScript Client Library. At the root directory of the cloned repo:
npm run genjs [VERSION_NUMBER]
Step 4: Finding the Generated JavaScript Files
If everything goes well, the generated JavaScript files should be saved to azure-storage-node/browser/bundle. There will be 8 generated JavaScript files totally:
azure-storage.blob.jsazure-storage.table.jsazure-storage.queue.jsazure-storage.file.jsazure-storage.blob.min.jsazure-storage.table.min.jsazure-storage.queue.min.jsazure-storage.file.min.js