Skip to content

Commit

Permalink
Azure#54: adding jsDocs in azure.js.
Browse files Browse the repository at this point in the history
  • Loading branch information
Andre Rodrigues committed Feb 11, 2012
1 parent 7541a24 commit 3350c49
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions lib/azure.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,15 @@ var exports = module.exports;
var TableService = require('./services/table/tableservice');
exports.TableService = TableService;

/**
* Creates a new TableService object.
* If no storageaccount or storageaccesskey are provided, the AZURE_STORAGE_ACCOUNT and AZURE_STORAGE_ACCESS_KEY environment variables will be used.
*
* @param {string} [storageAccount] The storage account.
* @param {string} [storageAccessKey] The storage access key.
* @param {string} [host] The host address.
* @param {object} [authenticationProvider] The authentication provider.
*/
exports.createTableService = function (storageAccount, storageAccessKey, host, authenticationProvider) {
return new TableService(storageAccount, storageAccessKey, host, authenticationProvider);
};
Expand All @@ -33,6 +42,15 @@ exports.createTableService = function (storageAccount, storageAccessKey, host, a
var BlobService = require('./services/blob/blobservice');
exports.BlobService = BlobService;

/**
* Creates a new BlobService object.
* If no storageaccount or storageaccesskey are provided, the AZURE_STORAGE_ACCOUNT and AZURE_STORAGE_ACCESS_KEY environment variables will be used.
*
* @param {string} [storageAccount] The storage account.
* @param {string} [storageAccessKey] The storage access key.
* @param {string} [host] The host address.
* @param {object} [authenticationProvider] The authentication provider.
*/
exports.createBlobService = function (storageAccount, storageAccessKey, host, authenticationProvider) {
return new BlobService(storageAccount, storageAccessKey, host, authenticationProvider);
};
Expand All @@ -44,6 +62,16 @@ exports.createBlobService = function (storageAccount, storageAccessKey, host, au
var QueueService = require('./services/queue/queueservice');
exports.QueueService = QueueService;

/**
* Creates a new QueueService object.
* If no storageAccount or storageAccessKey are provided, the AZURE_STORAGE_ACCOUNT and AZURE_STORAGE_ACCESS_KEY
* environment variables will be used.
*
* @param {string} [storageAccount] The storage account.
* @param {string} [storageAccessKey] The storage access key.
* @param {string} [host] The host address.
* @param {object} [authenticationProvider] The authentication provider.
*/
exports.createQueueService = function (storageAccount, storageAccessKey, host, authenticationProvider) {
return new QueueService(storageAccount, storageAccessKey, host, authenticationProvider);
};
Expand All @@ -55,6 +83,16 @@ exports.createQueueService = function (storageAccount, storageAccessKey, host, a
var ServiceBusService = require('./services/serviceBus/servicebusservice');
exports.ServiceBusService = ServiceBusService;

/**
* Creates a new ServiceBusService object.
*
* @param {string} [namespace] The service bus namespace.
* @param {string} [acsnamespace] The acs namespace. Usually the same as the sb namespace with "-sb" suffix.
* @param {string} [issuer] The issuer.
* @param {string} [password] The password.
* @param {string} [host] The host address.
* @param {object} [authenticationProvider] The authentication provider.
*/
exports.createServiceBusService = function (namespace, acsnamespace, issuer, password, host, authenticationProvider) {
return new ServiceBusService(namespace, acsnamespace, issuer, password, host, authenticationProvider);
};
Expand Down

0 comments on commit 3350c49

Please sign in to comment.