Skip to content
This repository was archived by the owner on Mar 4, 2026. It is now read-only.

Commit 1c49922

Browse files
authored
fix(cloud-rad): move comments for TSDoc (#1509)
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
1 parent 61968c0 commit 1c49922

File tree

8 files changed

+386
-386
lines changed

8 files changed

+386
-386
lines changed

src/backup.ts

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -117,8 +117,6 @@ class Backup {
117117
};
118118
}
119119

120-
create(options: CreateBackupOptions): Promise<CreateBackupResponse>;
121-
create(options: CreateBackupOptions, callback: CreateBackupCallback): void;
122120
/**
123121
* @typedef {object} CreateBackupOptions
124122
* @property {string} databasePath The database path.
@@ -183,6 +181,8 @@ class Backup {
183181
* await backupOperation.promise();
184182
* ```
185183
*/
184+
create(options: CreateBackupOptions): Promise<CreateBackupResponse>;
185+
create(options: CreateBackupOptions, callback: CreateBackupCallback): void;
186186
create(
187187
options: CreateBackupOptions,
188188
callback?: CreateBackupCallback
@@ -229,9 +229,6 @@ class Backup {
229229
);
230230
}
231231

232-
getMetadata(gaxOptions?: CallOptions): Promise<GetMetadataResponse>;
233-
getMetadata(callback: GetMetadataCallback): void;
234-
getMetadata(gaxOptions: CallOptions, callback: GetMetadataCallback): void;
235232
/**
236233
* @typedef {array} GetMetadataResponse
237234
* @property {object} 0 The {@link Backup} metadata.
@@ -266,6 +263,9 @@ class Backup {
266263
* console.log(`${backupInfo.name}: size=${backupInfo.sizeBytes}`);
267264
* ```
268265
*/
266+
getMetadata(gaxOptions?: CallOptions): Promise<GetMetadataResponse>;
267+
getMetadata(callback: GetMetadataCallback): void;
268+
getMetadata(gaxOptions: CallOptions, callback: GetMetadataCallback): void;
269269
getMetadata(
270270
gaxOptionsOrCallback?: CallOptions | GetMetadataCallback,
271271
cb?: GetMetadataCallback
@@ -298,12 +298,6 @@ class Backup {
298298
);
299299
}
300300

301-
getState(): Promise<
302-
| EnumKey<typeof databaseAdmin.spanner.admin.database.v1.Backup.State>
303-
| undefined
304-
| null
305-
>;
306-
getState(callback: GetStateCallback): void;
307301
/**
308302
* Retrieves the state of the backup.
309303
*
@@ -326,6 +320,12 @@ class Backup {
326320
* const backupCompleted = (state === 'READY');
327321
* ```
328322
*/
323+
getState(): Promise<
324+
| EnumKey<typeof databaseAdmin.spanner.admin.database.v1.Backup.State>
325+
| undefined
326+
| null
327+
>;
328+
getState(callback: GetStateCallback): void;
329329
async getState(): Promise<
330330
| EnumKey<typeof databaseAdmin.spanner.admin.database.v1.Backup.State>
331331
| undefined
@@ -335,8 +335,6 @@ class Backup {
335335
return backupInfo.state;
336336
}
337337

338-
getExpireTime(): Promise<PreciseDate | undefined>;
339-
getExpireTime(callback: GetExpireTimeCallback): void;
340338
/**
341339
* Retrieves the expiry time of the backup.
342340
*
@@ -357,13 +355,13 @@ class Backup {
357355
* console.log(`Backup expires on ${expireTime.toISOString()}`);
358356
* ```
359357
*/
358+
getExpireTime(): Promise<PreciseDate | undefined>;
359+
getExpireTime(callback: GetExpireTimeCallback): void;
360360
async getExpireTime(): Promise<PreciseDate | undefined> {
361361
const [backupInfo] = await this.getMetadata();
362362
return new PreciseDate(backupInfo.expireTime as DateStruct);
363363
}
364364

365-
exists(): Promise<boolean>;
366-
exists(callback: ExistsCallback): void;
367365
/**
368366
* Checks whether the backup exists.
369367
*
@@ -383,6 +381,8 @@ class Backup {
383381
* console.log(`Does backup exist? ${alreadyExists}`);
384382
* ```
385383
*/
384+
exists(): Promise<boolean>;
385+
exists(callback: ExistsCallback): void;
386386
async exists(): Promise<boolean> {
387387
try {
388388
// Attempt to read metadata to determine whether backup exists
@@ -398,22 +398,6 @@ class Backup {
398398
}
399399
}
400400

401-
updateExpireTime(
402-
expireTime: string | number | p.ITimestamp | PreciseDate
403-
): Promise<databaseAdmin.spanner.admin.database.v1.IBackup>;
404-
updateExpireTime(
405-
expireTime: string | number | p.ITimestamp | PreciseDate,
406-
gaxOptions?: CallOptions
407-
): Promise<databaseAdmin.spanner.admin.database.v1.IBackup>;
408-
updateExpireTime(
409-
expireTime: string | number | p.ITimestamp | PreciseDate,
410-
callback: UpdateExpireTimeCallback
411-
): void;
412-
updateExpireTime(
413-
expireTime: string | number | p.ITimestamp | PreciseDate,
414-
gaxOptions: CallOptions,
415-
callback: UpdateExpireTimeCallback
416-
): void;
417401
/**
418402
* @callback UpdateExpireTimeCallback
419403
* @param {?Error} err Request error, if any.
@@ -446,6 +430,22 @@ class Backup {
446430
* await backup.updateExpireTime(newExpireTime);
447431
* ```
448432
*/
433+
updateExpireTime(
434+
expireTime: string | number | p.ITimestamp | PreciseDate
435+
): Promise<databaseAdmin.spanner.admin.database.v1.IBackup>;
436+
updateExpireTime(
437+
expireTime: string | number | p.ITimestamp | PreciseDate,
438+
gaxOptions?: CallOptions
439+
): Promise<databaseAdmin.spanner.admin.database.v1.IBackup>;
440+
updateExpireTime(
441+
expireTime: string | number | p.ITimestamp | PreciseDate,
442+
callback: UpdateExpireTimeCallback
443+
): void;
444+
updateExpireTime(
445+
expireTime: string | number | p.ITimestamp | PreciseDate,
446+
gaxOptions: CallOptions,
447+
callback: UpdateExpireTimeCallback
448+
): void;
449449
updateExpireTime(
450450
expireTime: string | number | p.ITimestamp | PreciseDate,
451451
gaxOptionsOrCallback?: CallOptions | UpdateExpireTimeCallback,
@@ -483,9 +483,6 @@ class Backup {
483483
);
484484
}
485485

486-
delete(gaxOptions?: CallOptions): Promise<databaseAdmin.protobuf.IEmpty>;
487-
delete(callback: DeleteCallback): void;
488-
delete(gaxOptions: CallOptions, callback: DeleteCallback): void;
489486
/**
490487
* Deletes a backup.
491488
*
@@ -505,6 +502,9 @@ class Backup {
505502
* await backup.delete();
506503
* ```
507504
*/
505+
delete(gaxOptions?: CallOptions): Promise<databaseAdmin.protobuf.IEmpty>;
506+
delete(callback: DeleteCallback): void;
507+
delete(gaxOptions: CallOptions, callback: DeleteCallback): void;
508508
delete(
509509
gaxOptionsOrCallback?: CallOptions | DeleteCallback,
510510
cb?: DeleteCallback

0 commit comments

Comments
 (0)