Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 3 commits into from
Nov 8, 2021
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ca50ccd
fix(cloud-rad): move comments for TSDoc
fhinkel Nov 8, 2021
29475bd
Revert "fix(cloud-rad): move comments for TSDoc"
fhinkel Nov 8, 2021
eaf9435
Fix promisifyAll deletion
fhinkel Nov 8, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 23 additions & 23 deletions src/iam.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,9 +105,6 @@ export class IAM {
this.id = id;
}

getPolicy(gaxOpts?: CallOptions): Promise<GetPolicyResponse>;
getPolicy(callback: GetPolicyCallback): void;
getPolicy(gaxOpts: CallOptions, callback: GetPolicyCallback): void;
/**
* @typedef {array} GetPolicyResponse
* @property {object} 0 The policy.
Expand Down Expand Up @@ -149,6 +146,9 @@ export class IAM {
* });
* ```
*/
getPolicy(gaxOpts?: CallOptions): Promise<GetPolicyResponse>;
getPolicy(callback: GetPolicyCallback): void;
getPolicy(gaxOpts: CallOptions, callback: GetPolicyCallback): void;
getPolicy(
optsOrCallback?: CallOptions | GetPolicyCallback,
callback?: GetPolicyCallback
Expand All @@ -171,13 +171,6 @@ export class IAM {
);
}

setPolicy(policy: Policy, gaxOpts?: CallOptions): Promise<SetPolicyResponse>;
setPolicy(
policy: Policy,
gaxOpts: CallOptions,
callback: SetPolicyCallback
): void;
setPolicy(policy: Policy, callback: SetPolicyCallback): void;
/**
* @typedef {array} SetPolicyResponse
* @property {object} 0 The policy.
Expand Down Expand Up @@ -237,6 +230,13 @@ export class IAM {
* });
* ```
*/
setPolicy(policy: Policy, gaxOpts?: CallOptions): Promise<SetPolicyResponse>;
setPolicy(
policy: Policy,
gaxOpts: CallOptions,
callback: SetPolicyCallback
): void;
setPolicy(policy: Policy, callback: SetPolicyCallback): void;
setPolicy(
policy: Policy,
optsOrCallback?: CallOptions | SetPolicyCallback,
Expand Down Expand Up @@ -265,19 +265,6 @@ export class IAM {
);
}

testPermissions(
permissions: string | string[],
gaxOpts?: CallOptions
): Promise<TestIamPermissionsResponse>;
testPermissions(
permissions: string | string[],
gaxOpts: CallOptions,
callback: TestIamPermissionsCallback
): void;
testPermissions(
permissions: string | string[],
callback: TestIamPermissionsCallback
): void;
/**
* @callback TestIamPermissionsCallback
* @param {?Error} err Request error, if any.
Expand Down Expand Up @@ -356,6 +343,19 @@ export class IAM {
* });
* ```
*/
testPermissions(
permissions: string | string[],
gaxOpts?: CallOptions
): Promise<TestIamPermissionsResponse>;
testPermissions(
permissions: string | string[],
gaxOpts: CallOptions,
callback: TestIamPermissionsCallback
): void;
testPermissions(
permissions: string | string[],
callback: TestIamPermissionsCallback
): void;
testPermissions(
permissions: string | string[],
optsOrCallback?: CallOptions | TestIamPermissionsCallback,
Expand Down
22 changes: 11 additions & 11 deletions src/publisher/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,8 +95,6 @@ export class Publisher {
this.orderedQueues = new Map();
}

flush(): Promise<void>;
flush(callback: EmptyCallback): void;
/**
* Immediately sends all remaining queued data. This is mostly useful
* if you are planning to call close() on the PubSub object that holds
Expand All @@ -107,6 +105,8 @@ export class Publisher {
* @param {EmptyCallback} [callback] Callback function.
* @returns {Promise<EmptyResponse>}
*/
flush(): Promise<void>;
flush(callback: EmptyCallback): void;
flush(callback?: EmptyCallback): Promise<void> | void {
const definedCallback = callback ? callback : () => {};

Expand All @@ -122,13 +122,6 @@ export class Publisher {
})
.catch(definedCallback);
}
publish(data: Buffer, attributes?: Attributes): Promise<string>;
publish(data: Buffer, callback: PublishCallback): void;
publish(
data: Buffer,
attributes: Attributes,
callback: PublishCallback
): void;
/**
* Publish the provided message.
*
Expand All @@ -143,6 +136,13 @@ export class Publisher {
* @param {PublishCallback} [callback] Callback function.
* @returns {Promise<PublishResponse>}
*/
publish(data: Buffer, attributes?: Attributes): Promise<string>;
publish(data: Buffer, callback: PublishCallback): void;
publish(
data: Buffer,
attributes: Attributes,
callback: PublishCallback
): void;
publish(
data: Buffer,
attrsOrCb?: Attributes | PublishCallback,
Expand All @@ -153,8 +153,6 @@ export class Publisher {
return this.publishMessage({data, attributes}, callback!);
}

publishMessage(message: PubsubMessage): Promise<string>;
publishMessage(message: PubsubMessage, callback: PublishCallback): void;
/**
* Publish the provided message.
*
Expand All @@ -166,6 +164,8 @@ export class Publisher {
* @param {PubsubMessage} [message] Options for this message.
* @param {PublishCallback} [callback] Callback function.
*/
publishMessage(message: PubsubMessage): Promise<string>;
publishMessage(message: PubsubMessage, callback: PublishCallback): void;
publishMessage(
message: PubsubMessage,
callback?: PublishCallback
Expand Down
110 changes: 55 additions & 55 deletions src/pubsub.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,8 +313,6 @@ export class PubSub {
return this.projectId.indexOf(PROJECT_ID_PLACEHOLDER) < 0;
}

close(): Promise<void>;
close(callback: EmptyCallback): void;
/**
* Closes out this object, releasing any server connections. Note that once
* you close a PubSub object, it may not be used again. Any pending operations
Expand All @@ -326,6 +324,8 @@ export class PubSub {
* @callback EmptyCallback
* @returns {Promise<void>}
*/
close(): Promise<void>;
close(callback: EmptyCallback): void;
close(callback?: EmptyCallback): Promise<void> | void {
const definedCallback = callback || (() => {});
if (this.isOpen) {
Expand Down Expand Up @@ -395,22 +395,6 @@ export class PubSub {
return new Schema(this, schemaName);
}

createSubscription(
topic: Topic | string,
name: string,
options?: CreateSubscriptionOptions
): Promise<CreateSubscriptionResponse>;
createSubscription(
topic: Topic | string,
name: string,
callback: CreateSubscriptionCallback
): void;
createSubscription(
topic: Topic | string,
name: string,
options: CreateSubscriptionOptions,
callback: CreateSubscriptionCallback
): void;
/**
* @typedef {array} CreateSubscriptionResponse
* @property {Subscription} 0 The new {@link Subscription}.
Expand Down Expand Up @@ -495,6 +479,22 @@ export class PubSub {
* });
* ```
*/
createSubscription(
topic: Topic | string,
name: string,
options?: CreateSubscriptionOptions
): Promise<CreateSubscriptionResponse>;
createSubscription(
topic: Topic | string,
name: string,
callback: CreateSubscriptionCallback
): void;
createSubscription(
topic: Topic | string,
name: string,
options: CreateSubscriptionOptions,
callback: CreateSubscriptionCallback
): void;
createSubscription(
topic: Topic | string,
name: string,
Expand Down Expand Up @@ -556,19 +556,6 @@ export class PubSub {
);
}

createTopic(
name: string | TopicMetadata,
gaxOpts?: CallOptions
): Promise<CreateTopicResponse>;
createTopic(
name: string | TopicMetadata,
callback: CreateTopicCallback
): void;
createTopic(
name: string | TopicMetadata,
gaxOpts: CallOptions,
callback: CreateTopicCallback
): void;
/**
* @typedef {array} CreateTopicResponse
* @property {Topic} 0 The new {@link Topic}.
Expand Down Expand Up @@ -611,6 +598,19 @@ export class PubSub {
* });
* ```
*/
createTopic(
name: string | TopicMetadata,
gaxOpts?: CallOptions
): Promise<CreateTopicResponse>;
createTopic(
name: string | TopicMetadata,
callback: CreateTopicCallback
): void;
createTopic(
name: string | TopicMetadata,
gaxOpts: CallOptions,
callback: CreateTopicCallback
): void;
createTopic(
name: string | TopicMetadata,
optsOrCallback?: CallOptions | CreateTopicCallback,
Expand Down Expand Up @@ -650,16 +650,6 @@ export class PubSub {
);
}

detachSubscription(
name: string,
gaxOpts?: CallOptions
): Promise<DetachSubscriptionResponse>;
detachSubscription(name: string, callback: DetachSubscriptionCallback): void;
detachSubscription(
name: string,
gaxOpts: CallOptions,
callback: DetachSubscriptionCallback
): void;
/**
* Detach a subscription with the given name.
*
Expand Down Expand Up @@ -690,6 +680,16 @@ export class PubSub {
* });
* ```
*/
detachSubscription(
name: string,
gaxOpts?: CallOptions
): Promise<DetachSubscriptionResponse>;
detachSubscription(name: string, callback: DetachSubscriptionCallback): void;
detachSubscription(
name: string,
gaxOpts: CallOptions,
callback: DetachSubscriptionCallback
): void;
detachSubscription(
name: string,
optsOrCallback?: CallOptions | DetachSubscriptionCallback,
Expand Down Expand Up @@ -823,9 +823,6 @@ export class PubSub {
}
}

getSnapshots(options?: PageOptions): Promise<GetSnapshotsResponse>;
getSnapshots(callback: GetSnapshotsCallback): void;
getSnapshots(options: PageOptions, callback: GetSnapshotsCallback): void;
/**
* Query object for listing snapshots.
*
Expand Down Expand Up @@ -874,6 +871,9 @@ export class PubSub {
* });
* ```
*/
getSnapshots(options?: PageOptions): Promise<GetSnapshotsResponse>;
getSnapshots(callback: GetSnapshotsCallback): void;
getSnapshots(options: PageOptions, callback: GetSnapshotsCallback): void;
getSnapshots(
optsOrCallback?: PageOptions | GetSnapshotsCallback,
callback?: GetSnapshotsCallback
Expand Down Expand Up @@ -926,14 +926,6 @@ export class PubSub {
);
}

getSubscriptions(
options?: GetSubscriptionsOptions
): Promise<GetSubscriptionsResponse>;
getSubscriptions(callback: GetSubscriptionsCallback): void;
getSubscriptions(
options: GetSubscriptionsOptions,
callback: GetSubscriptionsCallback
): void;
/**
* Query object for listing subscriptions.
*
Expand Down Expand Up @@ -993,6 +985,14 @@ export class PubSub {
* });
* ```
*/
getSubscriptions(
options?: GetSubscriptionsOptions
): Promise<GetSubscriptionsResponse>;
getSubscriptions(callback: GetSubscriptionsCallback): void;
getSubscriptions(
options: GetSubscriptionsOptions,
callback: GetSubscriptionsCallback
): void;
getSubscriptions(
optsOrCallback?: GetSubscriptionsOptions | GetSubscriptionsCallback,
callback?: GetSubscriptionsCallback
Expand Down Expand Up @@ -1052,9 +1052,6 @@ export class PubSub {
);
}

getTopics(options?: PageOptions): Promise<GetTopicsResponse>;
getTopics(callback: GetTopicsCallback): void;
getTopics(options: PageOptions, callback: GetTopicsCallback): void;
/**
* Query object for listing topics.
*
Expand Down Expand Up @@ -1113,6 +1110,9 @@ export class PubSub {
* });
* ```
*/
getTopics(options?: PageOptions): Promise<GetTopicsResponse>;
getTopics(callback: GetTopicsCallback): void;
getTopics(options: PageOptions, callback: GetTopicsCallback): void;
getTopics(
optsOrCallback?: PageOptions | GetTopicsCallback,
callback?: GetTopicsCallback
Expand Down
Loading