Skip to content

Commit 43f2c42

Browse files
stephenplusplusstephenplusplus
committed
docs: remove nextQuery docs & annotate arrays correctly
1 parent bf9929e commit 43f2c42

19 files changed

Lines changed: 40 additions & 132 deletions

File tree

‎packages/bigquery/src/dataset.js‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -272,8 +272,6 @@ Dataset.prototype.delete = function(options, callback) {
272272
* @param {?error} callback.err - An error returned while making this request
273273
* @param {module:bigquery/table[]} callback.tables - The list of tables from
274274
* your Dataset.
275-
* @param {?object} callback.nextQuery - If present, query with this object to
276-
* check for more results.
277275
* @param {object} callback.apiResponse - The full API response.
278276
*
279277
* @example

‎packages/bigquery/src/index.js‎

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -152,8 +152,6 @@ BigQuery.prototype.dataset = function(id) {
152152
* @param {?error} callback.err - An error returned while making this request
153153
* @param {module:bigquery/dataset[]} callback.datasets - The list of datasets
154154
* in your project.
155-
* @param {?object} callback.nextQuery - If present, query with this object to
156-
* check for more results.
157155
* @param {object} callback.apiResponse - The full API response.
158156
*
159157
* @example
@@ -259,8 +257,6 @@ BigQuery.prototype.getDatasets = function(query, callback) {
259257
* @param {?error} callback.err - An error returned while making this request
260258
* @param {module:bigquery/job[]} callback.jobs - The list of jobs in your
261259
* project.
262-
* @param {?object} callback.nextQuery - If present, query with this object to
263-
* check for more results.
264260
* @param {object} callback.apiResponse - The full API response.
265261
*
266262
* @example
@@ -359,20 +355,12 @@ BigQuery.prototype.job = function(id) {
359355
/**
360356
* Run a query scoped to your project.
361357
*
362-
* If you provide a callback, this method returns the results from your query to
363-
* it. When querying large sets of data, it is possible your results won't be
364-
* returned all at once. In those cases, you will receive a third argument to
365-
* your callback that can be passed back to this method to return more results.
366-
*
367-
* See the examples below for such a workflow.
368-
*
369358
* This method also runs as a readable stream if you do not provide a callback.
370-
* In cases where more results exist, this will automatically run the subsequent
371-
* queries for you, pushing each row to the stream.
372359
*
373360
* @resource [Jobs: query API Documentation]{@link https://cloud.google.com/bigquery/docs/reference/v2/jobs/query}
374361
*
375362
* @param {string|object} options - A string SQL query or configuration object.
363+
* See all of the options outlined [here](https://cloud.google.com/bigquery/docs/reference/v2/jobs/query#request-body).
376364
* @param {boolean} options.autoPaginate - Have pagination handled
377365
* automatically. Default: true.
378366
* @param {number} options.maxApiCalls - Maximum number of API calls to make.
@@ -386,8 +374,6 @@ BigQuery.prototype.job = function(id) {
386374
* @param {function=} callback - The callback function.
387375
* @param {?error} callback.err - An error returned while making this request
388376
* @param {array} callback.rows - The list of results from your query.
389-
* @param {?object} callback.nextQuery - If present, query with this object to
390-
* check for more results.
391377
* @param {object} callback.apiResponse - The full API response.
392378
*
393379
* @example

‎packages/bigquery/src/table.js‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -577,8 +577,6 @@ Table.prototype.export = function(destination, options, callback) {
577577
* @param {function} callback - The callback function.
578578
* @param {?error} callback.err - An error returned while making this request
579579
* @param {array} callback.rows - The table data from specified set of rows.
580-
* @param {?object} callback.nextQuery - If present, query with this object to
581-
* check for more results.
582580
* @param {object} callback.apiResponse - The full API response.
583581
*
584582
* @example

‎packages/bigtable/src/index.js‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -435,8 +435,6 @@ Bigtable.prototype.createInstance = function(name, options, callback) {
435435
* @param {?error} callback.error - An error returned while making this request.
436436
* @param {module:bigtable/instance[]} callback.instances - List of all
437437
* instances.
438-
* @param {object} callback.nextQuery - If present, query with this object to
439-
* check for more results.
440438
* @param {object} callback.apiResponse - The full API response.
441439
*
442440
* @example

‎packages/bigtable/src/instance.js‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -451,8 +451,6 @@ Instance.prototype.cluster = function(name) {
451451
* @param {?error} callback.error - An error returned while making this request.
452452
* @param {module:bigtable/cluster[]} callback.clusters - List of all
453453
* Clusters.
454-
* @param {object} callback.nextQuery - If present, query with this object to
455-
* check for more results.
456454
* @param {object} callback.apiResponse - The full API response.
457455
*
458456
* @example
@@ -554,8 +552,6 @@ Instance.prototype.getClusters = function(query, callback) {
554552
* @param {function} callback - The callback function.
555553
* @param {?error} callback.err - An error returned while making this request.
556554
* @param {module:bigtable/table[]} callback.tables - List of all Tables.
557-
* @param {object} callback.nextQuery - If present, query with this object to
558-
* check for more results.
559555
* @param {object} callback.apiResponse - The full API response.
560556
*
561557
* @example

‎packages/compute/src/index.js‎

Lines changed: 17 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -579,10 +579,8 @@ Compute.prototype.firewall = function(name) {
579579
* representing part of the larger set of results to view.
580580
* @param {function} callback - The callback function.
581581
* @param {?error} callback.err - An error returned while making this request.
582-
* @param {module:compute/address} callback.addresses - Address objects from
582+
* @param {module:compute/address[]} callback.addresses - Address objects from
583583
* your project.
584-
* @param {?object} callback.nextQuery - If present, query with this object to
585-
* check for more results.
586584
* @param {object} callback.apiResponse - The full API response.
587585
*
588586
* @example
@@ -698,8 +696,6 @@ Compute.prototype.getAddresses = function(options, callback) {
698696
* @param {?error} callback.err - An error returned while making this request.
699697
* @param {module:compute/autoscaler[]} callback.autoscalers - Autoscaler
700698
* objects from your project.
701-
* @param {?object} callback.nextQuery - If present, query with this object to
702-
* check for more results.
703699
* @param {object} callback.apiResponse - The full API response.
704700
*
705701
* @example
@@ -815,9 +811,8 @@ Compute.prototype.getAutoscalers = function(options, callback) {
815811
* representing part of the larger set of results to view.
816812
* @param {function} callback - The callback function.
817813
* @param {?error} callback.err - An error returned while making this request.
818-
* @param {module:compute/disk} callback.disks - Disk objects from your project.
819-
* @param {?object} callback.nextQuery - If present, query with this object to
820-
* check for more results.
814+
* @param {module:compute/disk[]} callback.disks - Disk objects from your
815+
* project.
821816
* @param {object} callback.apiResponse - The full API response.
822817
*
823818
* @example
@@ -932,8 +927,6 @@ Compute.prototype.getDisks = function(options, callback) {
932927
* @param {?error} callback.err - An error returned while making this request.
933928
* @param {module:compute/instance-group[]} callback.instanceGroups -
934929
* InstanceGroup objects from your project.
935-
* @param {?object} callback.nextQuery - If present, query with this object to
936-
* check for more results.
937930
* @param {object} callback.apiResponse - The full API response.
938931
*
939932
* @example
@@ -1045,10 +1038,8 @@ Compute.prototype.getInstanceGroups = function(options, callback) {
10451038
* representing part of the larger set of results to view.
10461039
* @param {function} callback - The callback function.
10471040
* @param {?error} callback.err - An error returned while making this request.
1048-
* @param {module:compute/firewall} callback.firewalls - Firewall objects from
1041+
* @param {module:compute/firewall[]} callback.firewalls - Firewall objects from
10491042
* your project.
1050-
* @param {?object} callback.nextQuery - If present, query with this object to
1051-
* check for more results.
10521043
* @param {object} callback.apiResponse - The full API response.
10531044
*
10541045
* @example
@@ -1154,10 +1145,8 @@ Compute.prototype.getFirewalls = function(options, callback) {
11541145
* representing part of the larger set of results to view.
11551146
* @param {function} callback - The callback function.
11561147
* @param {?error} callback.err - An error returned while making this request.
1157-
* @param {module:compute/health-check} callback.healthChecks - HealthCheck
1148+
* @param {module:compute/health-check[]} callback.healthChecks - HealthCheck
11581149
* objects from your project.
1159-
* @param {?object} callback.nextQuery - If present, query with this object to
1160-
* check for more results.
11611150
* @param {object} callback.apiResponse - The full API response.
11621151
*
11631152
* @example
@@ -1269,8 +1258,6 @@ Compute.prototype.getHealthChecks = function(options, callback) {
12691258
* @param {?error} callback.err - An error returned while making this request.
12701259
* @param {module:compute/machine-type[]} callback.machineTypes - MachineType
12711260
* objects from your project.
1272-
* @param {?object} callback.nextQuery - If present, query with this object to
1273-
* check for more results.
12741261
* @param {object} callback.apiResponse - The full API response.
12751262
*
12761263
* @example
@@ -1382,10 +1369,8 @@ Compute.prototype.getMachineTypes = function(options, callback) {
13821369
* representing part of the larger set of results to view.
13831370
* @param {function} callback - The callback function.
13841371
* @param {?error} callback.err - An error returned while making this request.
1385-
* @param {module:compute/network} callback.networks - Network objects from your
1386-
* project.
1387-
* @param {?object} callback.nextQuery - If present, query with this object to
1388-
* check for more results.
1372+
* @param {module:compute/network[]} callback.networks - Network objects from
1373+
* your project.
13891374
* @param {object} callback.apiResponse - The full API response.
13901375
*
13911376
* @example
@@ -1488,10 +1473,8 @@ Compute.prototype.getNetworks = function(options, callback) {
14881473
* representing part of the larger set of results to view.
14891474
* @param {function} callback - The callback function.
14901475
* @param {?error} callback.err - An error returned while making this request.
1491-
* @param {module:compute/operation} callback.operations - Operation objects
1476+
* @param {module:compute/operation[]} callback.operations - Operation objects
14921477
* from your project.
1493-
* @param {?object} callback.nextQuery - If present, query with this object to
1494-
* check for more results.
14951478
* @param {object} callback.apiResponse - The full API response.
14961479
*
14971480
* @example
@@ -1594,10 +1577,8 @@ Compute.prototype.getOperations = function(options, callback) {
15941577
* representing part of the larger set of results to view.
15951578
* @param {function} callback - The callback function.
15961579
* @param {?error} callback.err - An error returned while making this request.
1597-
* @param {module:compute/region} callback.regions - Region objects that are
1580+
* @param {module:compute/region[]} callback.regions - Region objects that are
15981581
* available to your project.
1599-
* @param {?object} callback.nextQuery - If present, query with this object to
1600-
* check for more results.
16011582
* @param {object} callback.apiResponse - The full API response.
16021583
*
16031584
* @example
@@ -1697,9 +1678,8 @@ Compute.prototype.getRegions = function(options, callback) {
16971678
* representing part of the larger set of results to view.
16981679
* @param {function} callback - The callback function.
16991680
* @param {?error} callback.err - An error returned while making this request.
1700-
* @param {module:compute/rule} callback.rules - Rule objects from this region.
1701-
* @param {?object} callback.nextQuery - If present, query with this object to
1702-
* check for more results.
1681+
* @param {module:compute/rule[]} callback.rules - Rule objects from your
1682+
* project.
17031683
* @param {object} callback.apiResponse - The full API response.
17041684
*
17051685
* @example
@@ -1804,8 +1784,6 @@ Compute.prototype.getRules = function(options, callback) {
18041784
* @param {?error} callback.err - An error returned while making this request.
18051785
* @param {module:compute/service[]} callback.services - Service objects from
18061786
* your project.
1807-
* @param {?object} callback.nextQuery - If present, query with this object to
1808-
* check for more results.
18091787
* @param {object} callback.apiResponse - The full API response.
18101788
*
18111789
* @example
@@ -1908,10 +1886,8 @@ Compute.prototype.getServices = function(options, callback) {
19081886
* representing part of the larger set of results to view.
19091887
* @param {function} callback - The callback function.
19101888
* @param {?error} callback.err - An error returned while making this request.
1911-
* @param {module:compute/snapshot} callback.snapshots - Snapshot objects from
1889+
* @param {module:compute/snapshot[]} callback.snapshots - Snapshot objects from
19121890
* your project.
1913-
* @param {?object} callback.nextQuery - If present, query with this object to
1914-
* check for more results.
19151891
* @param {object} callback.apiResponse - The full API response.
19161892
*
19171893
* @example
@@ -2014,10 +1990,8 @@ Compute.prototype.getSnapshots = function(options, callback) {
20141990
* representing part of the larger set of results to view.
20151991
* @param {function} callback - The callback function.
20161992
* @param {?error} callback.err - An error returned while making this request.
2017-
* @param {module:compute/subnetwork} callback.subnetworks - Subnetwork objects
2018-
* from your project.
2019-
* @param {?object} callback.nextQuery - If present, query with this object to
2020-
* check for more results.
1993+
* @param {module:compute/subnetwork[]} callback.subnetworks - Subnetwork
1994+
* objects from your project.
20211995
* @param {object} callback.apiResponse - The full API response.
20221996
*
20231997
* @example
@@ -2129,9 +2103,7 @@ Compute.prototype.getSubnetworks = function(options, callback) {
21292103
* representing part of the larger set of results to view.
21302104
* @param {function} callback - The callback function.
21312105
* @param {?error} callback.err - An error returned while making this request.
2132-
* @param {module:compute/vm} callback.vms - VM objects from your project.
2133-
* @param {?object} callback.nextQuery - If present, query with this object to
2134-
* check for more results.
2106+
* @param {module:compute/vm[]} callback.vms - VM objects from your project.
21352107
* @param {object} callback.apiResponse - The full API response.
21362108
*
21372109
* @example
@@ -2243,10 +2215,8 @@ Compute.prototype.getVMs = function(options, callback) {
22432215
* representing part of the larger set of results to view.
22442216
* @param {function} callback - The callback function.
22452217
* @param {?error} callback.err - An error returned while making this request.
2246-
* @param {module:compute/zone} callback.zones - Zone objects that are available
2247-
* to your project.
2248-
* @param {?object} callback.nextQuery - If present, query with this object to
2249-
* check for more results.
2218+
* @param {module:compute/zone[]} callback.zones - Zone objects that are
2219+
* available to your project.
22502220
* @param {object} callback.apiResponse - The full API response.
22512221
*
22522222
* @example

‎packages/compute/src/instance-group.js‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -258,8 +258,6 @@ InstanceGroup.prototype.delete = function(callback) {
258258
* @param {?error} callback.err - An error returned while making this request.
259259
* @param {module:compute/vm[]} callback.vms - VM objects from this isntance
260260
* group.
261-
* @param {?object} callback.nextQuery - If present, query with this object to
262-
* check for more results.
263261
* @param {object} callback.apiResponse - The full API response.
264262
*
265263
* @example

‎packages/compute/src/network.js‎

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -275,10 +275,8 @@ Network.prototype.createSubnetwork = function(name, config, callback) {
275275
* representing part of the larger set of results to view.
276276
* @param {function} callback - The callback function.
277277
* @param {?error} callback.err - An error returned while making this request.
278-
* @param {module:compute/subnetwork} callback.subnetworks - Subnetwork objects
279-
* from this network.
280-
* @param {?object} callback.nextQuery - If present, query with this object to
281-
* check for more results.
278+
* @param {module:compute/subnetwork[]} callback.subnetworks - Subnetwork
279+
* objects from this network.
282280
* @param {object} callback.apiResponse - The full API response.
283281
*
284282
* @example
@@ -405,10 +403,8 @@ Network.prototype.firewall = function(name) {
405403
* representing part of the larger set of results to view.
406404
* @param {function} callback - The callback function.
407405
* @param {?error} callback.err - An error returned while making this request.
408-
* @param {module:compute/firewall} callback.firewalls - Firewall objects from
406+
* @param {module:compute/firewall[]} callback.firewalls - Firewall objects from
409407
* this network.
410-
* @param {?object} callback.nextQuery - If present, query with this object to
411-
* check for more results.
412408
* @param {object} callback.apiResponse - The full API response.
413409
*
414410
* @example

‎packages/compute/src/region.js‎

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -356,10 +356,8 @@ Region.prototype.createRule = function(name, config, callback) {
356356
* representing part of the larger set of results to view.
357357
* @param {function} callback - The callback function.
358358
* @param {?error} callback.err - An error returned while making this request.
359-
* @param {module:compute/address} callback.addresses - Address objects from
359+
* @param {module:compute/address[]} callback.addresses - Address objects from
360360
* this region.
361-
* @param {?object} callback.nextQuery - If present, query with this object to
362-
* check for more results.
363361
* @param {object} callback.apiResponse - The full API response.
364362
*
365363
* @example
@@ -462,10 +460,8 @@ Region.prototype.getAddresses = function(options, callback) {
462460
* representing part of the larger set of results to view.
463461
* @param {function} callback - The callback function.
464462
* @param {?error} callback.err - An error returned while making this request.
465-
* @param {module:compute/operation} callback.operations - Operation objects
463+
* @param {module:compute/operation[]} callback.operations - Operation objects
466464
* from this region.
467-
* @param {?object} callback.nextQuery - If present, query with this object to
468-
* check for more results.
469465
* @param {object} callback.apiResponse - The full API response.
470466
*
471467
* @example
@@ -567,9 +563,8 @@ Region.prototype.getOperations = function(options, callback) {
567563
* representing part of the larger set of results to view.
568564
* @param {function} callback - The callback function.
569565
* @param {?error} callback.err - An error returned while making this request.
570-
* @param {module:compute/rule} callback.rules - Rule objects from this region.
571-
* @param {?object} callback.nextQuery - If present, query with this object to
572-
* check for more results.
566+
* @param {module:compute/rule[]} callback.rules - Rule objects from this
567+
* region.
573568
* @param {object} callback.apiResponse - The full API response.
574569
*
575570
* @example
@@ -674,8 +669,6 @@ Region.prototype.getRules = function(options, callback) {
674669
* @param {?error} callback.err - An error returned while making this request.
675670
* @param {module:compute/subnetwork[]} callback.subnetworks - Subnetwork
676671
* objects from this region.
677-
* @param {?object} callback.nextQuery - If present, query with this object to
678-
* check for more results.
679672
* @param {object} callback.apiResponse - The full API response.
680673
*
681674
* @example

0 commit comments

Comments
 (0)