Standardization of our documentation comments

sdk/tables/data-tables/src/TableBatch.ts

@@ -51,9 +51,9 @@ export class TableBatchImpl implements TableBatch {
   public readonly partitionKey: string;
 
   /**
-   * @param url Tables account url
-   * @param partitionKey partition key
-   * @param credential credential to authenticate the batch request
+   * @param url - Tables account url
+   * @param partitionKey - partition key
+   * @param credential - credential to authenticate the batch request
    */
   constructor(
     url: string,
@@ -87,7 +87,7 @@ export class TableBatchImpl implements TableBatch {
 
   /**
    * Adds a createEntity operation to the batch
-   * @param entity Entity to create
+   * @param entity - Entity to create
    */
   public createEntity<T extends object>(entity: TableEntity<T>): void {
     this.checkPartitionKey(entity.partitionKey);
@@ -96,20 +96,20 @@ export class TableBatchImpl implements TableBatch {
 
   /**
    * Adds a createEntity operation to the batch per each entity in the entities array
-   * @param entitites Array of entities to create
+   * @param entities - Array of entities to create
    */
-  public createEntities<T extends object>(entitites: TableEntity<T>[]): void {
-    for (const entity of entitites) {
+  public createEntities<T extends object>(entities: TableEntity<T>[]): void {
+    for (const entity of entities) {
       this.checkPartitionKey(entity.partitionKey);
       this.pendingOperations.push(this.interceptClient.createEntity(entity));
     }
   }
 
   /**
    * Adds a deleteEntity operation to the batch
-   * @param partitionKey partition key of the entity to delete
-   * @param rowKey row key of the entity to delete
-   * @param options options for the delete operation
+   * @param partitionKey - Partition key of the entity to delete
+   * @param rowKey - Row key of the entity to delete
+   * @param options - Options for the delete operation
    */
   public deleteEntity(
     partitionKey: string,
@@ -122,9 +122,9 @@ export class TableBatchImpl implements TableBatch {
 
   /**
    * Adds an updateEntity operation to the batch
-   * @param entity entity to update
-   * @param mode update mode (Merge or Replace)
-   * @param options options for the update operation
+   * @param entity - Entity to update
+   * @param mode - Update mode (Merge or Replace)
+   * @param options - Options for the update operation
    */
   public updateEntity<T extends object>(
     entity: TableEntity<T>,
@@ -245,9 +245,8 @@ function parseBatchResponse(batchResponse: HttpOperationResponse): TableBatchRes
 
 /**
  * Prepares the operation url to be added to the body, removing the SAS token if present
- * @export
- * @param {string} url Source URL string
- * @returns {(string | undefined)}
+ * @param url - Source URL string
+ * @returns
  */
 function getSubRequestUrl(url: string): string {
   const sasTokenParts = ["sv", "ss", "srt", "sp", "se", "st", "spr", "sig"];
@@ -258,7 +257,7 @@ function getSubRequestUrl(url: string): string {
 
 /**
  * This method creates a batch request object that provides functions to build the envelope and body for a batch request
- * @param batchGuid Id of the batch
+ * @param batchGuid - Id of the batch
  */
 export function createInnerBatchRequest(batchGuid: string, changesetId: string): InnerBatchRequest {
   const HTTP_LINE_ENDING = "\r\n";

sdk/tables/data-tables/src/TableClient.ts

@@ -68,11 +68,11 @@ export class TableClient {
   /**
    * Creates a new instance of the TableClient class.
    *
-   * @param {string} url The URL of the service account that is the target of the desired operation., such as
+   * @param url - The URL of the service account that is the target of the desired operation., such as
    *                     "https://myaccount.table.core.windows.net".
-   * @param {string} tableName the name of the table
-   * @param {TablesSharedKeyCredential} credential  TablesSharedKeyCredential used to authenticate requests. Only Supported for Browsers
-   * @param {TableClientOptions} options Optional. Options to configure the HTTP pipeline.
+   * @param tableName - the name of the table
+   * @param credential - TablesSharedKeyCredential used to authenticate requests. Only Supported for Browsers
+   * @param options - Optional. Options to configure the HTTP pipeline.
    *
    * Example using an account name/key:
    *
@@ -97,11 +97,11 @@ export class TableClient {
   /**
    * Creates an instance of TableClient.
    *
-   * @param {string} url A Client string pointing to Azure Storage table service, such as
-   *                     "https://myaccount.table.core.windows.net". You can append a SAS,
-   *                      such as "https://myaccount.table.core.windows.net?sasString".
-   * @param {string} tableName the name of the table
-   * @param {TableClientOptions} options Optional. Options to configure the HTTP pipeline.
+   * @param url - A Client string pointing to Azure Storage table service, such as
+   *              "https://myaccount.table.core.windows.net". You can append a SAS,
+   *              such as "https://myaccount.table.core.windows.net?sasString".
+   * @param tableName - the name of the table
+   * @param options - Options to configure the HTTP pipeline.
    *
    * Example appending a SAS token:
    *
@@ -170,7 +170,7 @@ export class TableClient {
 
   /**
    * Permanently deletes the current table with all of its entities.
-   * @param options The options parameters.
+   * @param options - The options parameters.
    */
   // eslint-disable-next-line @azure/azure-sdk/ts-naming-options
   public async delete(options: DeleteTableOptions = {}): Promise<DeleteTableResponse> {
@@ -187,7 +187,7 @@ export class TableClient {
 
   /**
    *  Creates the current table it it doesn't exist
-   * @param options The options parameters.
+   * @param options - The options parameters.
    */
   // eslint-disable-next-line @azure/azure-sdk/ts-naming-options
   public async create(options: CreateTableOptions = {}): Promise<CreateTableItemResponse> {
@@ -204,9 +204,9 @@ export class TableClient {
 
   /**
    * Returns a single entity in the table.
-   * @param partitionKey The partition key of the entity.
-   * @param rowKey The row key of the entity.
-   * @param options The options parameters.
+   * @param partitionKey - The partition key of the entity.
+   * @param rowKey - The row key of the entity.
+   * @param options - The options parameters.
    */
   public async getEntity<T extends object>(
     partitionKey: string,
@@ -240,8 +240,8 @@ export class TableClient {
 
   /**
    * Queries entities in a table.
-   * @param tableName The name of the table.
-   * @param options The options parameters.
+   * @param tableName - The name of the table.
+   * @param options - The options parameters.
    */
   public listEntities<T extends object>(
     // eslint-disable-next-line @azure/azure-sdk/ts-naming-options
@@ -347,8 +347,8 @@ export class TableClient {
 
   /**
    * Insert entity in the table.
-   * @param entity The properties for the table entity.
-   * @param options The options parameters.
+   * @param entity - The properties for the table entity.
+   * @param options - The options parameters.
    */
   public async createEntity<T extends object>(
     entity: TableEntity<T>,
@@ -375,9 +375,9 @@ export class TableClient {
 
   /**
    * Deletes the specified entity in the table.
-   * @param partitionKey The partition key of the entity.
-   * @param rowKey The row key of the entity.
-   * @param options The options parameters.
+   * @param partitionKey - The partition key of the entity.
+   * @param rowKey - The row key of the entity.
+   * @param options - The options parameters.
    */
   public async deleteEntity(
     partitionKey: string,
@@ -410,11 +410,11 @@ export class TableClient {
 
   /**
    * Update an entity in the table.
-   * @param entity The properties of the entity to be updated.
-   * @param mode The different modes for updating the entity:
-   *             - Merge: Updates an entity by updating the entity's properties without replacing the existing entity.
-   *             - Replace: Updates an existing entity by replacing the entire entity.
-   * @param options The options parameters.
+   * @param entity - The properties of the entity to be updated.
+   * @param mode - The different modes for updating the entity:
+   *               - Merge: Updates an entity by updating the entity's properties without replacing the existing entity.
+   *               - Replace: Updates an existing entity by replacing the entire entity.
+   * @param options - The options parameters.
    */
   public async updateEntity<T extends object>(
     entity: TableEntity<T>,
@@ -456,12 +456,12 @@ export class TableClient {
 
   /**
    * Upsert an entity in the table.
-   * @param tableName The name of the table.
-   * @param entity The properties for the table entity.
-   * @param mode The different modes for updating the entity:
-   *             - Merge: Updates an entity by updating the entity's properties without replacing the existing entity.
-   *             - Replace: Updates an existing entity by replacing the entire entity.
-   * @param options The options parameters.
+   * @param tableName - The name of the table.
+   * @param entity - The properties for the table entity.
+   * @param mode - The different modes for updating the entity:
+   *               - Merge: Updates an entity by updating the entity's properties without replacing the existing entity.
+   *               - Replace: Updates an existing entity by replacing the entire entity.
+   * @param options - The options parameters.
    */
   public async upsertEntity<T extends object>(
     entity: TableEntity<T>,
@@ -503,7 +503,7 @@ export class TableClient {
 
   /**
    * Creates a new Batch to collect sub-operations that can be submitted together via submitBatch
-   * @param partitionKey partitionKey to which the batch operations will be targetted to
+   * @param partitionKey - partitionKey to which the batch operations will be targetted to
    */
   // eslint-disable-next-line @azure/azure-sdk/ts-naming-options
   public createBatch(partitionKey: string): TableBatch {
@@ -535,14 +535,14 @@ export class TableClient {
    *
    * Creates an instance of TableClient from connection string.
    *
-   * @param {string} 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.table.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 {TableClientOptions} [options] Options to configure the HTTP pipeline.
-   * @returns {TableClient} A new TableClient from the given connection string.
+   * @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.table.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 options - Options to configure the HTTP pipeline.
+   * @returns A new TableClient from the given connection string.
    */
   public static fromConnectionString(
     connectionString: string,

sdk/tables/data-tables/src/TableServiceClient.ts

@@ -49,11 +49,11 @@ export class TableServiceClient {
   /**
    * Creates a new instance of the TableServiceClient class.
    *
-   * @param {string} url The URL of the service account that is the target of the desired operation., such as
-   *                     "https://myaccount.table.core.windows.net". You can append a SAS,
-   *                     such as "https://myaccount.table.core.windows.net?sasString".
-   * @param {TablesSharedKeyCredential} credential  TablesSharedKeyCredential used to authenticate requests. Only Supported for Browsers
-   * @param {TableServiceClientOptions} options Optional. Options to configure the HTTP pipeline.
+   * @param url - The URL of the service account that is the target of the desired operation., such as
+   *              "https://myaccount.table.core.windows.net". You can append a SAS,
+   *              such as "https://myaccount.table.core.windows.net?sasString".
+   * @param credential - TablesSharedKeyCredential used to authenticate requests. Only Supported for Browsers
+   * @param options - Options to configure the HTTP pipeline.
    *
    * Example using an account name/key:
    *
@@ -75,10 +75,10 @@ export class TableServiceClient {
   /**
    * Creates a new instance of the TableServiceClient class.
    *
-   * @param {string} url The URL of the service account that is the target of the desired operation., such as
-   *                     "https://myaccount.table.core.windows.net". You can append a SAS,
-   *                     such as "https://myaccount.table.core.windows.net?sasString".
-   * @param {TableServiceClientOptions} options Optional. Options to configure the HTTP pipeline.
+   * @param url - The URL of the service account that is the target of the desired operation., such as
+   *              "https://myaccount.table.core.windows.net". You can append a SAS,
+   *              such as "https://myaccount.table.core.windows.net?sasString".
+   * @param options - Options to configure the HTTP pipeline.
    * Example appending a SAS token:
    *
    * ```js
@@ -132,7 +132,7 @@ export class TableServiceClient {
   /**
    * Retrieves statistics related to replication for the Table service. It is only available on the
    * secondary location endpoint when read-access geo-redundant replication is enabled for the account.
-   * @param options The options parameters.
+   * @param options - The options parameters.
    */
   public getStatistics(options: GetStatisticsOptions = {}): Promise<GetStatisticsResponse> {
     const { span, updatedOptions } = createSpan("TableServiceClient-getStatistics", options);
@@ -149,7 +149,7 @@ export class TableServiceClient {
   /**
    * Gets the properties of an account's Table service, including properties for Analytics and CORS
    * (Cross-Origin Resource Sharing) rules.
-   * @param options The options parameters.
+   * @param options - The options parameters.
    */
   public getProperties(options: GetPropertiesOptions = {}): Promise<GetPropertiesResponse> {
     const { span, updatedOptions } = createSpan("TableServiceClient-getProperties", options);
@@ -166,8 +166,8 @@ export class TableServiceClient {
   /**
    * Sets properties for an account's Table service endpoint, including properties for Analytics and CORS
    * (Cross-Origin Resource Sharing) rules.
-   * @param properties The Table Service properties.
-   * @param options The options parameters.
+   * @param properties - The Table Service properties.
+   * @param options - The options parameters.
    */
   public setProperties(
     properties: ServiceProperties,
@@ -186,8 +186,8 @@ export class TableServiceClient {
 
   /**
    * Creates a new table under the given account.
-   * @param tableName The name of the table.
-   * @param options The options parameters.
+   * @param tableName - The name of the table.
+   * @param options - The options parameters.
    */
   public createTable(
     tableName: string,
@@ -209,8 +209,8 @@ export class TableServiceClient {
 
   /**
    * Operation permanently deletes the specified table.
-   * @param tableName The name of the table.
-   * @param options The options parameters.
+   * @param tableName - The name of the table.
+   * @param options - The options parameters.
    */
   public deleteTable(
     tableName: string,
@@ -229,7 +229,7 @@ export class TableServiceClient {
 
   /**
    * Queries tables under the given account.
-   * @param options The options parameters.
+   * @param options - The options parameters.
    */
   public listTables(
     // eslint-disable-next-line @azure/azure-sdk/ts-naming-options
@@ -310,8 +310,8 @@ export class TableServiceClient {
   /**
    * Retrieves details about any stored access policies specified on the table that may be used with
    * Shared Access Signatures.
-   * @param tableName The name of the table.
-   * @param options The options parameters.
+   * @param tableName - The name of the table.
+   * @param options - The options parameters.
    */
   public getAccessPolicy(
     tableName: string,
@@ -330,9 +330,9 @@ export class TableServiceClient {
 
   /**
    * Sets stored access policies for the table that may be used with Shared Access Signatures.
-   * @param tableName The name of the table.
-   * @param acl The Access Control List for the table.
-   * @param options The options parameters.
+   * @param tableName - The name of the table.
+   * @param acl - The Access Control List for the table.
+   * @param options - The options parameters.
    */
   public setAccessPolicy(
     tableName: string,
@@ -353,14 +353,14 @@ export class TableServiceClient {
    *
    * Creates an instance of TableServiceClient from connection string.
    *
-   * @param {string} 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.table.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 {TableServiceClientOptions} [options] Options to configure the HTTP pipeline.
-   * @returns {TableServiceClient} A new TableServiceClient from the given connection string.
+   * @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.table.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 options - Options to configure the HTTP pipeline.
+   * @returns A new TableServiceClient from the given connection string.
    */
   public static fromConnectionString(
     connectionString: string,

sdk/tables/data-tables/src/TablesSharedKeyCredential.browser.ts

@@ -4,8 +4,8 @@
 export class TablesSharedKeyCredential {
   /**
    * Creates an instance of TablesSharedKeyCredential.
-   * @param {string} accountName
-   * @param {string} accountKey
+   * @param accountName -
+   * @param accountKey -
    */
   constructor(_accountName: string, _accountKey: string) {
     throw new Error("TablesSharedKeyCredential is only supported in Node.js environment");