fix(cloud-rad): move comments for TSDoc (#1040)

As we move our ref docs to cloud.google.com, we rely on TSDoc rather JSDoc. TSDoc expects comments before the first overloaded function, we currently have those on the last function. Those comments don't make it into the d.ts files. We need to move comments to the first overloaded function rather than the last one. Internally b/190631834 Script used: https://github.com/fhinkel/cloud-rad-script/blob/main/moveComments.js
googleapis · Nov 6, 2021 · 93c5e14 · 93c5e14
1 parent 618242c
commit 93c5e14
Show file tree

Hide file tree

Showing 5 changed files with 210 additions and 210 deletions.
diff --git a/src/bigquery.ts b/src/bigquery.ts
@@ -1172,16 +1172,6 @@ export class BigQuery extends common.Service {
     );
   }
 
-  createDataset(
-    id: string,
-    options?: DatasetResource
-  ): Promise<DatasetResponse>;
-  createDataset(
-    id: string,
-    options: DatasetResource,
-    callback: DatasetCallback
-  ): void;
-  createDataset(id: string, callback: DatasetCallback): void;
   /**
    * @callback DatasetCallback
    * @param {?Error} err Request error, if any.
@@ -1219,6 +1209,16 @@ export class BigQuery extends common.Service {
    * });
    * ```
    */
+  createDataset(
+    id: string,
+    options?: DatasetResource
+  ): Promise<DatasetResponse>;
+  createDataset(
+    id: string,
+    options: DatasetResource,
+    callback: DatasetCallback
+  ): void;
+  createDataset(id: string, callback: DatasetCallback): void;
   createDataset(
     id: string,
     optionsOrCallback?: DatasetResource | DatasetCallback,
@@ -1260,8 +1260,6 @@ export class BigQuery extends common.Service {
     );
   }
 
-  createQueryJob(options: Query | string): Promise<JobResponse>;
-  createQueryJob(options: Query | string, callback: JobCallback): void;
   /**
    * @callback JobCallback
    * @param {?Error} err Request error, if any.
@@ -1357,6 +1355,8 @@ export class BigQuery extends common.Service {
    * });
    * ```
    */
+  createQueryJob(options: Query | string): Promise<JobResponse>;
+  createQueryJob(options: Query | string, callback: JobCallback): void;
   createQueryJob(
     opts: Query | string,
     callback?: JobCallback
@@ -1492,8 +1492,6 @@ export class BigQuery extends common.Service {
     this.createJob(reqOpts, callback!);
   }
 
-  createJob(options: JobOptions): Promise<JobResponse>;
-  createJob(options: JobOptions, callback: JobCallback): void;
   /**
    * Creates a job. Typically when creating a job you'll have a very specific
    * task in mind. For this we recommend one of the following methods:
@@ -1553,6 +1551,8 @@ export class BigQuery extends common.Service {
    * });
    * ```
    */
+  createJob(options: JobOptions): Promise<JobResponse>;
+  createJob(options: JobOptions, callback: JobCallback): void;
   createJob(
     options: JobOptions,
     callback?: JobCallback
@@ -1659,9 +1659,6 @@ export class BigQuery extends common.Service {
     return new Dataset(this, id, options);
   }
 
-  getDatasets(options?: GetDatasetsOptions): Promise<DatasetsResponse>;
-  getDatasets(options: GetDatasetsOptions, callback: DatasetsCallback): void;
-  getDatasets(callback: DatasetsCallback): void;
   /**
    * List all or some of the datasets in your project.
    *
@@ -1712,6 +1709,9 @@ export class BigQuery extends common.Service {
    * bigquery.getDatasets().then(function(datasets) {});
    * ```
    */
+  getDatasets(options?: GetDatasetsOptions): Promise<DatasetsResponse>;
+  getDatasets(options: GetDatasetsOptions, callback: DatasetsCallback): void;
+  getDatasets(callback: DatasetsCallback): void;
   getDatasets(
     optionsOrCallback?: GetDatasetsOptions | DatasetsCallback,
     cb?: DatasetsCallback
@@ -1757,9 +1757,6 @@ export class BigQuery extends common.Service {
     );
   }
 
-  getJobs(options?: GetJobsOptions): Promise<GetJobsResponse>;
-  getJobs(options: GetJobsOptions, callback: GetJobsCallback): void;
-  getJobs(callback: GetJobsCallback): void;
   /**
    * @callback GetJobsCallback
    * @param {?Error} err Request error, if any.
@@ -1829,6 +1826,9 @@ export class BigQuery extends common.Service {
    * });
    * ```
    */
+  getJobs(options?: GetJobsOptions): Promise<GetJobsResponse>;
+  getJobs(options: GetJobsOptions, callback: GetJobsCallback): void;
+  getJobs(callback: GetJobsCallback): void;
   getJobs(
     optionsOrCallback?: GetJobsOptions | GetJobsCallback,
     cb?: GetJobsCallback
@@ -1890,20 +1890,6 @@ export class BigQuery extends common.Service {
     return new Job(this, id, options);
   }
 
-  query(query: string, options?: QueryOptions): Promise<QueryRowsResponse>;
-  query(query: Query, options?: QueryOptions): Promise<SimpleQueryRowsResponse>;
-  query(
-    query: string,
-    options: QueryOptions,
-    callback?: QueryRowsCallback
-  ): void;
-  query(
-    query: Query,
-    options: QueryOptions,
-    callback?: SimpleQueryRowsCallback
-  ): void;
-  query(query: string, callback?: QueryRowsCallback): void;
-  query(query: Query, callback?: SimpleQueryRowsCallback): void;
   /**
    * Run a query scoped to your project. For manual pagination please refer to
    * {@link BigQuery#createQueryJob}.
@@ -2021,6 +2007,20 @@ export class BigQuery extends common.Service {
    * });
    * ```
    */
+  query(query: string, options?: QueryOptions): Promise<QueryRowsResponse>;
+  query(query: Query, options?: QueryOptions): Promise<SimpleQueryRowsResponse>;
+  query(
+    query: string,
+    options: QueryOptions,
+    callback?: QueryRowsCallback
+  ): void;
+  query(
+    query: Query,
+    options: QueryOptions,
+    callback?: SimpleQueryRowsCallback
+  ): void;
+  query(query: string, callback?: QueryRowsCallback): void;
+  query(query: Query, callback?: SimpleQueryRowsCallback): void;
   query(
     query: string | Query,
     optionsOrCallback?:

diff --git a/src/dataset.ts b/src/dataset.ts
@@ -484,8 +484,6 @@ class Dataset extends ServiceObject {
     this.getTablesStream = paginator.streamify<Table>('getTables');
   }
 
-  createQueryJob(options: string | Query): Promise<JobResponse>;
-  createQueryJob(options: string | Query, callback: JobCallback): void;
   /**
    * Run a query as a job. No results are immediately returned. Instead, your
    * callback will be executed with a {@link Job} object that you must
@@ -498,6 +496,8 @@ class Dataset extends ServiceObject {
    * @param {JobCallback} [callback] See {@link BigQuery#createQueryJob} for full documentation of this method.
    * @returns {Promise<JobResponse>} See {@link BigQuery#createQueryJob} for full documentation of this method.
    */
+  createQueryJob(options: string | Query): Promise<JobResponse>;
+  createQueryJob(options: string | Query, callback: JobCallback): void;
   createQueryJob(
     options: string | Query,
     callback?: JobCallback
@@ -544,12 +544,6 @@ class Dataset extends ServiceObject {
     return this.bigQuery.createQueryStream(options);
   }
 
-  createRoutine(id: string, config: RoutineMetadata): Promise<RoutineResponse>;
-  createRoutine(
-    id: string,
-    config: RoutineMetadata,
-    callback: RoutineCallback
-  ): void;
   /**
    * @callback CreateRoutineCallback
    * @param {?Error} err Request error, if any.
@@ -604,6 +598,12 @@ class Dataset extends ServiceObject {
    * const [routine, apiResponse] = await dataset.createRoutine(id, config);
    * ```
    */
+  createRoutine(id: string, config: RoutineMetadata): Promise<RoutineResponse>;
+  createRoutine(
+    id: string,
+    config: RoutineMetadata,
+    callback: RoutineCallback
+  ): void;
   createRoutine(
     id: string,
     config: RoutineMetadata,
@@ -636,13 +636,6 @@ class Dataset extends ServiceObject {
     );
   }
 
-  createTable(id: string, options: TableMetadata): Promise<TableResponse>;
-  createTable(
-    id: string,
-    options: TableMetadata,
-    callback: TableCallback
-  ): void;
-  createTable(id: string, callback: TableCallback): void;
   /**
    * @callback TableCallback
    * @param {?Error} err Request error, if any.
@@ -698,6 +691,13 @@ class Dataset extends ServiceObject {
    * });
    * ```
    */
+  createTable(id: string, options: TableMetadata): Promise<TableResponse>;
+  createTable(
+    id: string,
+    options: TableMetadata,
+    callback: TableCallback
+  ): void;
+  createTable(id: string, callback: TableCallback): void;
   createTable(
     id: string,
     optionsOrCallback?: TableMetadata | TableCallback,
@@ -737,9 +737,6 @@ class Dataset extends ServiceObject {
     );
   }
 
-  delete(options?: DatasetDeleteOptions): Promise<[Metadata]>;
-  delete(options: DatasetDeleteOptions, callback: DeleteCallback): void;
-  delete(callback: DeleteCallback): void;
   /**
    * @callback DeleteCallback
    * @param {?Error} err Request error, if any.
@@ -785,6 +782,9 @@ class Dataset extends ServiceObject {
    * });
    * ```
    */
+  delete(options?: DatasetDeleteOptions): Promise<[Metadata]>;
+  delete(options: DatasetDeleteOptions, callback: DeleteCallback): void;
+  delete(callback: DeleteCallback): void;
   delete(
     optionsOrCallback?: DeleteCallback | DatasetDeleteOptions,
     callback?: DeleteCallback
@@ -808,9 +808,6 @@ class Dataset extends ServiceObject {
     );
   }
 
-  getModels(options?: GetModelsOptions): Promise<GetModelsResponse>;
-  getModels(options: GetModelsOptions, callback: GetModelsCallback): void;
-  getModels(callback: GetModelsCallback): void;
   /**
    * @typedef {object} GetModelsOptions
    * @property {boolean} [autoPaginate=true] Have pagination handled
@@ -888,6 +885,9 @@ class Dataset extends ServiceObject {
    * });
    * ```
    */
+  getModels(options?: GetModelsOptions): Promise<GetModelsResponse>;
+  getModels(options: GetModelsOptions, callback: GetModelsCallback): void;
+  getModels(callback: GetModelsCallback): void;
   getModels(
     optsOrCb?: GetModelsOptions | GetModelsCallback,
     cb?: GetModelsCallback
@@ -924,9 +924,6 @@ class Dataset extends ServiceObject {
     );
   }
 
-  getRoutines(options?: GetRoutinesOptions): Promise<GetRoutinesResponse>;
-  getRoutines(options: GetRoutinesOptions, callback: GetRoutinesCallback): void;
-  getRoutines(callback: GetRoutinesCallback): void;
   /**
    * @typedef {object} GetRoutinesOptions
    * @property {boolean} [autoPaginate=true] Have pagination handled
@@ -1002,6 +999,9 @@ class Dataset extends ServiceObject {
    * const [routines] = await dataset.getRoutines();
    * ```
    */
+  getRoutines(options?: GetRoutinesOptions): Promise<GetRoutinesResponse>;
+  getRoutines(options: GetRoutinesOptions, callback: GetRoutinesCallback): void;
+  getRoutines(callback: GetRoutinesCallback): void;
   getRoutines(
     optsOrCb?: GetRoutinesOptions | GetRoutinesCallback,
     cb?: GetRoutinesCallback
@@ -1038,9 +1038,6 @@ class Dataset extends ServiceObject {
     );
   }
 
-  getTables(options?: GetTablesOptions): Promise<GetTablesResponse>;
-  getTables(options: GetTablesOptions, callback: GetTablesCallback): void;
-  getTables(callback: GetTablesCallback): void;
   /**
    * @typedef {object} GetTablesOptions
    * @property {boolean} [autoPaginate=true] Have pagination handled
@@ -1118,6 +1115,9 @@ class Dataset extends ServiceObject {
    * });
    * ```
    */
+  getTables(options?: GetTablesOptions): Promise<GetTablesResponse>;
+  getTables(options: GetTablesOptions, callback: GetTablesCallback): void;
+  getTables(callback: GetTablesCallback): void;
   getTables(
     optionsOrCallback?: GetTablesOptions | GetTablesCallback,
     cb?: GetTablesCallback
@@ -1183,10 +1183,6 @@ class Dataset extends ServiceObject {
     return new Model(this, id);
   }
 
-  query(options: Query): Promise<QueryRowsResponse>;
-  query(options: string): Promise<QueryRowsResponse>;
-  query(options: Query, callback: SimpleQueryRowsCallback): void;
-  query(options: string, callback: SimpleQueryRowsCallback): void;
   /**
    * Run a query scoped to your dataset.
    *
@@ -1197,6 +1193,10 @@ class Dataset extends ServiceObject {
    * @returns {Promise<SimpleQueryRowsResponse>}
    * @returns {Promise<QueryRowsResponse>} See {@link BigQuery#query} for full documentation of this method.
    */
+  query(options: Query): Promise<QueryRowsResponse>;
+  query(options: string): Promise<QueryRowsResponse>;
+  query(options: Query, callback: SimpleQueryRowsCallback): void;
+  query(options: string, callback: SimpleQueryRowsCallback): void;
   query(
     options: Query | string,
     callback?: SimpleQueryRowsCallback

diff --git a/src/job.ts b/src/job.ts
@@ -323,8 +323,6 @@ class Job extends Operation {
     );
   }
 
-  cancel(): Promise<CancelResponse>;
-  cancel(callback: CancelCallback): void;
   /**
    * @callback CancelCallback
    * @param {?Error} err Request error, if any.
@@ -368,6 +366,8 @@ class Job extends Operation {
    * });
    * ```
    */
+  cancel(): Promise<CancelResponse>;
+  cancel(callback: CancelCallback): void;
   cancel(callback?: CancelCallback): void | Promise<CancelResponse> {
     let qs;
 
@@ -385,12 +385,6 @@ class Job extends Operation {
     );
   }
 
-  getQueryResults(options?: QueryResultsOptions): Promise<QueryRowsResponse>;
-  getQueryResults(
-    options: QueryResultsOptions,
-    callback: QueryRowsCallback
-  ): void;
-  getQueryResults(callback: QueryRowsCallback): void;
   /**
    * Get the results of a job.
    *
@@ -465,6 +459,12 @@ class Job extends Operation {
    * });
    * ```
    */
+  getQueryResults(options?: QueryResultsOptions): Promise<QueryRowsResponse>;
+  getQueryResults(
+    options: QueryResultsOptions,
+    callback: QueryRowsCallback
+  ): void;
+  getQueryResults(callback: QueryRowsCallback): void;
   getQueryResults(
     optionsOrCallback?: QueryResultsOptions | QueryRowsCallback,
     cb?: QueryRowsCallback