[Storage] Update param, returns tags to follow TSDoc (Azure#13721)

* [Storage] Update param, returns tags to follow TSDoc * Fix the space next to returns
AzureSDKAutomation · Feb 18, 2021 · 350612d · 350612d
1 parent c80a2a4
commit 350612d
Show file tree

Hide file tree

Showing 158 changed files with 2,235 additions and 2,095 deletions.
diff --git a/sdk/storage/storage-blob-changefeed/src/BlobChangeFeedClient.ts b/sdk/storage/storage-blob-changefeed/src/BlobChangeFeedClient.ts
@@ -49,9 +49,9 @@ export class BlobChangeFeedEventPage {
  * Creates a new Pipeline object with Credential provided.
  *
  * @export
- * @param {StorageSharedKeyCredential | AnonymousCredential | TokenCredential} credential  Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used.
- * @param {StoragePipelineOptions} [pipelineOptions] Optional. Options.
- * @returns {Pipeline} A new Pipeline object.
+ * @param credential -  Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used.
+ * @param pipelineOptions - Optional. Options.
+ * @returns A new Pipeline object.
  */
 export function newPipeline(
   credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential,
@@ -99,13 +99,13 @@ export class BlobChangeFeedClient {
    *
    * Creates an instance of BlobChangeFeedClient from connection string.
    *
-   * @param {string} connectionString Account connection string or a SAS connection string of an Azure storage account.
+   * @param connectionString - Account connection string or a SAS connection string of an Azure storage account.
    *                                  [ Note - Account connection string can only be used in NODE.JS runtime. ]
    *                                  Account connection string example -
    *                                  `DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net`
    *                                  SAS connection string example -
    *                                  `BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString`
-   * @param {StoragePipelineOptions} [options] Optional. Options to configure the HTTP pipeline.
+   * @param options - Optional. Options to configure the HTTP pipeline.
    * @memberof BlobChangeFeedClient
    */
   public static fromConnectionString(
@@ -123,11 +123,11 @@ export class BlobChangeFeedClient {
   /**
    * Creates an instance of BlobChangeFeedClient.
    *
-   * @param {string} url A Client string pointing to Azure Storage blob service, such as
+   * @param url - A Client string pointing to Azure Storage blob service, such as
    *                     "https://myaccount.blob.core.windows.net". You can append a SAS
    *                     if using AnonymousCredential, such as "https://myaccount.blob.core.windows.net?sasString".
-   * @param {StorageSharedKeyCredential | AnonymousCredential | TokenCredential} credential  Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used.
-   * @param {StoragePipelineOptions} [options] Optional. Options to configure the HTTP pipeline.
+   * @param credential -  Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used.
+   * @param options - Optional. Options to configure the HTTP pipeline.
    * @memberof BlobChangeFeedClient
    *
    * Example using DefaultAzureCredential from `@azure/identity`:
@@ -164,10 +164,10 @@ export class BlobChangeFeedClient {
   /**
    * Creates an instance of BlobChangeFeedClient.
    *
-   * @param {string} url A Client string pointing to Azure Storage blob service, such as
+   * @param url - A Client string pointing to Azure Storage blob service, such as
    *                     "https://myaccount.blob.core.windows.net". You can append a SAS
    *                     if using AnonymousCredential, such as "https://myaccount.blob.core.windows.net?sasString".
-   * @param {Pipeline} pipeline Call newPipeline() to create a default
+   * @param pipeline - Call newPipeline() to create a default
    *                            pipeline, or provide a customized pipeline.
    * @memberof BlobChangeFeedClient
    */
@@ -322,8 +322,8 @@ export class BlobChangeFeedClient {
    * }
    * ```
    *
-   * @param {BlobChangeFeedListChangesOptions} [options={}] Options to list change feed events.
-   * @returns {PagedAsyncIterableIterator<BlobChangeFeedEvent, BlobChangeFeedEventPage>} An asyncIterableIterator that supports paging.
+   * @param options - Options to list change feed events.
+   * @returns An asyncIterableIterator that supports paging.
    * @memberof BlobChangeFeedClient
    */
   public listChanges(

diff --git a/sdk/storage/storage-blob-changefeed/src/LazyLoadingBlobStream.ts b/sdk/storage/storage-blob-changefeed/src/LazyLoadingBlobStream.ts
@@ -70,7 +70,7 @@ export class LazyLoadingBlobStream extends Readable {
   /**
    * Creates an instance of LazyLoadingBlobStream.
    *
-   * @param {number} byteLength The total length of data contained in the buffers
+   * @param byteLength - The total length of data contained in the buffers
    * @memberof LazyLoadingBlobStream
    */
   constructor(
@@ -129,7 +129,7 @@ export class LazyLoadingBlobStream extends Readable {
   /**
    * Internal _read() that will be called when the stream wants to pull more data in.
    *
-   * @param {number} size Optional. The size of data to be read
+   * @param size - Optional. The size of data to be read
    * @memberof LazyLoadingBlobStream
    */
   public async _read(size?: number) {

diff --git a/sdk/storage/storage-blob-changefeed/src/utils/utils.common.ts b/sdk/storage/storage-blob-changefeed/src/utils/utils.common.ts
@@ -26,8 +26,8 @@ export function floorToNearestHour(date: Date | undefined): Date | undefined {
  * Get host from an URL string.
  *
  * @export
- * @param {string} url Source URL string
- * @returns {(string | undefined)}
+ * @param url - Source URL string
+ *
  */
 export function getHost(url: string): string | undefined {
   const urlParsed = URLBuilder.parse(url);
@@ -38,8 +38,8 @@ export function getHost(url: string): string | undefined {
  * Get URI from an URL string.
  *
  * @export
- * @param {string} url Source URL string
- * @returns {(string | undefined)}
+ * @param url - Source URL string
+ *
  */
 export function getURI(url: string): string {
   const urlParsed = URLBuilder.parse(url);

diff --git a/sdk/storage/storage-blob-changefeed/test/utils/testutils.common.ts b/sdk/storage/storage-blob-changefeed/test/utils/testutils.common.ts
@@ -70,7 +70,7 @@ export class SimpleTokenCredential implements TokenCredential {
 
   /**
    * Creates an instance of TokenCredential.
-   * @param {string} token
+   * @param token -
    */
   constructor(token: string, expiresOn?: Date) {
     this.token = token;
@@ -82,7 +82,7 @@ export class SimpleTokenCredential implements TokenCredential {
    *
    * @param _scopes Ignored since token is already known.
    * @param _options Ignored since token is already known.
-   * @returns {AccessToken} The access token details.
+   * @returns The access token details.
    */
   async getToken(
     _scopes: string | string[],
@@ -141,8 +141,8 @@ export function isSuperSet(m1?: BlobMetadata, m2?: BlobMetadata): boolean {
  * Sleep for seconds.
  *
  * @export
- * @param {number} seconds
- * @returns {Promise<void>}
+ * @param seconds -
+ *
  */
 export function sleep(seconds: number): Promise<void> {
   return new Promise((resolve) => {
@@ -154,10 +154,10 @@ export function sleep(seconds: number): Promise<void> {
  * String.prototype.padStart()
  *
  * @export
- * @param {string} currentString
- * @param {number} targetLength
- * @param {string} [padString=" "]
- * @returns {string}
+ * @param currentString -
+ * @param targetLength -
+ * @param [padString=" - "]
+ *
  */
 export function padStart(
   currentString: string,

diff --git a/sdk/storage/storage-blob/src/BlobBatch.ts b/sdk/storage/storage-blob/src/BlobBatch.ts
@@ -131,10 +131,10 @@ export class BlobBatch {
    * The operation will be authenticated and authorized with specified credential.
    * See [blob batch authorization details](https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch#authorization).
    *
-   * @param {string} url The url of the blob resource to delete.
-   * @param {StorageSharedKeyCredential | AnonymousCredential | TokenCredential} credential Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used.
-   * @param {BlobDeleteOptions} [options]
-   * @returns {Promise<void>}
+   * @param url - The url of the blob resource to delete.
+   * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used.
+   * @param options -
+   *
    * @memberof BlobBatch
    */
   public async deleteBlob(
@@ -153,9 +153,9 @@ export class BlobBatch {
    * The operation will be authenticated and authorized with specified credential.
    * See [blob batch authorization details](https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch#authorization).
    *
-   * @param {BlobClient} blobClient The BlobClient.
-   * @param {BlobDeleteOptions} [options]
-   * @returns {Promise<void>}
+   * @param blobClient - The BlobClient.
+   * @param options -
+   *
    * @memberof BlobBatch
    */
   public async deleteBlob(blobClient: BlobClient, options?: BlobDeleteOptions): Promise<void>;
@@ -239,11 +239,11 @@ export class BlobBatch {
    * The operation will be authenticated and authorized
    * with specified credential. See [blob batch authorization details](https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch#authorization).
    *
-   * @param {string} url The url of the blob resource to delete.
-   * @param {StorageSharedKeyCredential | AnonymousCredential | TokenCredential} credential Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used.
-   * @param {AccessTier} tier
-   * @param {BlobSetTierOptions} [options]
-   * @returns {Promise<void>}
+   * @param url - The url of the blob resource to delete.
+   * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used.
+   * @param tier -
+   * @param options -
+   *
    * @memberof BlobBatch
    */
   public async setBlobAccessTier(
@@ -265,10 +265,10 @@ export class BlobBatch {
    * The operation will be authenticated and authorized
    * with specified credential. See [blob batch authorization details](https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch#authorization).
    *
-   * @param {BlobClient} blobClient The BlobClient.
-   * @param {AccessTier} tier
-   * @param {BlobSetTierOptions} [options]
-   * @returns {Promise<void>}
+   * @param blobClient - The BlobClient.
+   * @param tier -
+   * @param options -
+   *
    * @memberof BlobBatch
    */
   public async setBlobAccessTier(
@@ -392,7 +392,7 @@ class InnerBatchRequest {
    * credential and serialization/deserialization components, with additional policies to
    * filter unnecessary headers, assemble sub requests into request's body
    * and intercept request from going to wire.
-   * @param {StorageSharedKeyCredential | AnonymousCredential | TokenCredential} credential  Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used.
+   * @param credential -  Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used.
    */
   public createPipeline(
     credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

diff --git a/sdk/storage/storage-blob/src/BlobBatchClient.ts b/sdk/storage/storage-blob/src/BlobBatchClient.ts
@@ -80,11 +80,11 @@ export class BlobBatchClient {
   /**
    * Creates an instance of BlobBatchClient.
    *
-   * @param {string} url A url pointing to Azure Storage blob service, such as
+   * @param url - A url pointing to Azure Storage blob service, such as
    *                     "https://myaccount.blob.core.windows.net". You can append a SAS
    *                     if using AnonymousCredential, such as "https://myaccount.blob.core.windows.net?sasString".
-   * @param {StorageSharedKeyCredential | AnonymousCredential | TokenCredential} credential  Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used.
-   * @param {StoragePipelineOptions} [options] Options to configure the HTTP pipeline.
+   * @param credential -  Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used.
+   * @param options - Options to configure the HTTP pipeline.
    * @memberof BlobBatchClient
    */
   constructor(
@@ -95,10 +95,10 @@ export class BlobBatchClient {
   /**
    * Creates an instance of BlobBatchClient.
    *
-   * @param {string} url A url pointing to Azure Storage blob service, such as
+   * @param url - A url pointing to Azure Storage blob service, such as
    *                     "https://myaccount.blob.core.windows.net". You can append a SAS
    *                     if using AnonymousCredential, such as "https://myaccount.blob.core.windows.net?sasString".
-   * @param {Pipeline} pipeline Call newPipeline() to create a default
+   * @param pipeline - Call newPipeline() to create a default
    *                            pipeline, or provide a customized pipeline.
    * @memberof BlobBatchClient
    */
@@ -148,10 +148,10 @@ export class BlobBatchClient {
    * The operations will be authenticated and authorized with specified credential.
    * See [blob batch authorization details](https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch#authorization).
    *
-   * @param {string[]} urls The urls of the blob resources to delete.
-   * @param {StorageSharedKeyCredential | AnonymousCredential | TokenCredential} credential  Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used.
-   * @param {BlobDeleteOptions} [options]
-   * @returns {Promise<BlobBatchDeleteBlobsResponse>}
+   * @param urls - The urls of the blob resources to delete.
+   * @param credential -  Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used.
+   * @param options -
+   *
    * @memberof BlobBatchClient
    */
   public async deleteBlobs(
@@ -167,9 +167,9 @@ export class BlobBatchClient {
    * The operation(subrequest) will be authenticated and authorized with specified credential.
    * See [blob batch authorization details](https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch#authorization).
    *
-   * @param {BlobClient[]} blobClients The BlobClients for the blobs to delete.
-   * @param {BlobDeleteOptions} [options]
-   * @returns {Promise<BlobBatchDeleteBlobsResponse>}
+   * @param blobClients - The BlobClients for the blobs to delete.
+   * @param options -
+   *
    * @memberof BlobBatchClient
    */
   public async deleteBlobs(
@@ -209,11 +209,11 @@ export class BlobBatchClient {
    * The operation(subrequest) will be authenticated and authorized
    * with specified credential.See [blob batch authorization details](https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch#authorization).
    *
-   * @param {string[]} urls The urls of the blob resource to delete.
-   * @param {StorageSharedKeyCredential | AnonymousCredential | TokenCredential} credential  Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used.
-   * @param {AccessTier} tier
-   * @param {BlobSetTierOptions} [options]
-   * @returns {Promise<BlobBatchSetBlobsAccessTierResponse>}
+   * @param urls - The urls of the blob resource to delete.
+   * @param credential -  Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the @azure/identity package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used.
+   * @param tier -
+   * @param options -
+   *
    * @memberof BlobBatchClient
    */
   public async setBlobsAccessTier(
@@ -234,10 +234,10 @@ export class BlobBatchClient {
    * The operation(subrequest) will be authenticated and authorized
    * with specified credential.See [blob batch authorization details](https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch#authorization).
    *
-   * @param {BlobClient[]} blobClients The BlobClients for the blobs which should have a new tier set.
-   * @param {AccessTier} tier
-   * @param {BlobSetTierOptions} [options]
-   * @returns {Promise<BlobBatchSetBlobsAccessTierResponse>}
+   * @param blobClients - The BlobClients for the blobs which should have a new tier set.
+   * @param tier -
+   * @param options -
+   *
    * @memberof BlobBatchClient
    */
   public async setBlobsAccessTier(
@@ -308,9 +308,9 @@ export class BlobBatchClient {
    *
    * @see https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch
    *
-   * @param {BlobBatch} batchRequest A set of Delete or SetTier operations.
-   * @param {BlobBatchSubmitBatchOptionalParams} [options]
-   * @returns {Promise<BlobBatchSubmitBatchResponse>}
+   * @param batchRequest - A set of Delete or SetTier operations.
+   * @param options -
+   *
    * @memberof BlobBatchClient
    */
   public async submitBatch(

diff --git a/sdk/storage/storage-blob/src/BlobDownloadResponse.ts b/sdk/storage/storage-blob/src/BlobDownloadResponse.ts
@@ -572,11 +572,11 @@ export class BlobDownloadResponse implements BlobDownloadResponseParsed {
   /**
    * Creates an instance of BlobDownloadResponse.
    *
-   * @param {BlobDownloadResponseParsed} originalResponse
-   * @param {ReadableStreamGetter} getter
-   * @param {number} offset
-   * @param {number} count
-   * @param {RetriableReadableStreamOptions} [options={}]
+   * @param originalResponse -
+   * @param getter -
+   * @param offset -
+   * @param count -
+   * @param options -
    * @memberof BlobDownloadResponse
    */
   public constructor(