@google-cloud/pubsub 2.18.1 → 2.18.2

package/CHANGELOG.md

@@ -4,6 +4,13 @@
 
 [1]: https://www.npmjs.com/package/@google-cloud/pubsub?activeTab=versions
 
+### [2.18.2](https://www.github.com/googleapis/nodejs-pubsub/compare/v2.18.1...v2.18.2) (2021-11-08)
+
+
+### Bug Fixes
+
+* **cloud-rad:** move comments for TSDoc ([#1423](https://www.github.com/googleapis/nodejs-pubsub/issues/1423)) ([a40a23e](https://www.github.com/googleapis/nodejs-pubsub/commit/a40a23ee43c6697000996e0ff7070f41610397f5))
+
 ### [2.18.1](https://www.github.com/googleapis/nodejs-pubsub/compare/v2.18.0...v2.18.1) (2021-09-27)
 
 

package/build/src/iam.d.ts

@@ -62,6 +62,7 @@ export declare type TestIamPermissionsCallback = ResourceCallback<IamPermissions
  * @see [What is Cloud IAM?]{@link https://cloud.google.com/iam/}
  *
  * @example
+ * ```
  * const {PubSub} = require('@google-cloud/pubsub');
  * const pubsub = new PubSub();
  *
@@ -70,18 +71,197 @@ export declare type TestIamPermissionsCallback = ResourceCallback<IamPermissions
  *
  * const subscription = pubsub.subscription('my-subscription');
  * // subscription.iam
+ * ```
  */
 export declare class IAM {
     pubsub: PubSub;
     request: typeof PubSub.prototype.request;
     id: string;
     constructor(pubsub: PubSub, id: string);
+    /**
+     * @typedef {array} GetPolicyResponse
+     * @property {object} 0 The policy.
+     */
+    /**
+     * @callback GetPolicyCallback
+     * @param {?Error} err Request error, if any.
+     * @param {object} acl The policy.
+     */
+    /**
+     * Get the IAM policy
+     *
+     * @param {object} [gaxOptions] Request configuration options, outlined
+     *     here: https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html.
+     * @param {GetPolicyCallback} [callback] Callback function.
+     * @returns {Promise<GetPolicyResponse>}
+     *
+     * @see [Topics: getIamPolicy API Documentation]{@link https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics/getIamPolicy}
+     * @see [Subscriptions: getIamPolicy API Documentation]{@link https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.subscriptions/getIamPolicy}
+     *
+     * @example
+     * ```
+     * const {PubSub} = require('@google-cloud/pubsub');
+     * const pubsub = new PubSub();
+     *
+     * const topic = pubsub.topic('my-topic');
+     * const subscription = topic.subscription('my-subscription');
+     *
+     * topic.iam.getPolicy(function(err, policy, apiResponse) {});
+     *
+     * subscription.iam.getPolicy(function(err, policy, apiResponse) {});
+     *
+     * //-
+     * // If the callback is omitted, we'll return a Promise.
+     * //-
+     * topic.iam.getPolicy().then(function(data) {
+     *   const policy = data[0];
+     *   const apiResponse = data[1];
+     * });
+     * ```
+     */
     getPolicy(gaxOpts?: CallOptions): Promise<GetPolicyResponse>;
     getPolicy(callback: GetPolicyCallback): void;
     getPolicy(gaxOpts: CallOptions, callback: GetPolicyCallback): void;
+    /**
+     * @typedef {array} SetPolicyResponse
+     * @property {object} 0 The policy.
+     */
+    /**
+     * @callback SetPolicyCallback
+     * @param {?Error} err Request error, if any.
+     * @param {object} acl The policy.
+     */
+    /**
+     * Set the IAM policy
+     *
+     * @throws {Error} If no policy is provided.
+     *
+     * @param {object} policy The [policy](https://cloud.google.com/pubsub/docs/reference/rest/v1/Policy).
+     * @param {array} [policy.bindings] Bindings associate members with roles.
+     * @param {Array<object>} [policy.rules] Rules to be applied to the policy.
+     * @param {string} [policy.etag] Etags are used to perform a read-modify-write.
+     * @param {object} [gaxOptions] Request configuration options, outlined
+     *     here: https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html.
+     * @param {SetPolicyCallback} callback Callback function.
+     * @returns {Promise<SetPolicyResponse>}
+     *
+     * @see [Topics: setIamPolicy API Documentation]{@link https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics/setIamPolicy}
+     * @see [Subscriptions: setIamPolicy API Documentation]{@link https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.subscriptions/setIamPolicy}
+     * @see [Policy]{@link https://cloud.google.com/pubsub/docs/reference/rest/v1/Policy}
+     *
+     * @example
+     * ```
+     * const {PubSub} = require('@google-cloud/pubsub');
+     * const pubsub = new PubSub();
+     *
+     * const topic = pubsub.topic('my-topic');
+     * const subscription = topic.subscription('my-subscription');
+     *
+     * const myPolicy = {
+     *   bindings: [
+     *     {
+     *       role: 'roles/pubsub.subscriber',
+     *       members:
+     * ['serviceAccount:myotherproject@appspot.gserviceaccount.com']
+     *     }
+     *   ]
+     * };
+     *
+     * topic.iam.setPolicy(myPolicy, function(err, policy, apiResponse) {});
+     *
+     * subscription.iam.setPolicy(myPolicy, function(err, policy, apiResponse)
+     * {});
+     *
+     * //-
+     * // If the callback is omitted, we'll return a Promise.
+     * //-
+     * topic.iam.setPolicy(myPolicy).then(function(data) {
+     *   const policy = data[0];
+     *   const apiResponse = data[1];
+     * });
+     * ```
+     */
     setPolicy(policy: Policy, gaxOpts?: CallOptions): Promise<SetPolicyResponse>;
     setPolicy(policy: Policy, gaxOpts: CallOptions, callback: SetPolicyCallback): void;
     setPolicy(policy: Policy, callback: SetPolicyCallback): void;
+    /**
+     * @callback TestIamPermissionsCallback
+     * @param {?Error} err Request error, if any.
+     * @param {TestIamPermissionsAPIResponse} permissions A subset of permissions that the caller is allowed.
+     * @param {PermissionsResponse} apiResponse The full API response.
+     */
+    /**
+     * @typedef {array} TestIamPermissionsResponse
+     * @property {object[]} 0 A subset of permissions that the caller is allowed.
+     * @property {PermissionsResponse} 1 The full API response.
+     */
+    /**
+     * @typedef {string[]} PermissionsResponse
+     * A subset of TestPermissionsRequest.permissions that the caller is allowed.
+     * @see https://cloud.google.com/pubsub/docs/reference/rpc/google.iam.v1#google.iam.v1.TestIamPermissionsRequest
+     */
+    /**
+     * Test a set of permissions for a resource.
+     *
+     * Permissions with wildcards such as `*` or `storage.*` are not allowed.
+     *
+     * @throws {Error} If permissions are not provided.
+     *
+     * @param {string|string[]} permissions The permission(s) to test for.
+     * @param {object} [gaxOptions] Request configuration options, outlined
+     *     here: https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html.
+     * @param {TestIamPermissionsCallback} [callback] Callback function.
+     * @returns {Promise<TestIamPermissionsResponse>}
+     *
+     * @see [Topics: testIamPermissions API Documentation]{@link https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics/testIamPermissions}
+     * @see [Subscriptions: testIamPermissions API Documentation]{@link https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.subscriptions/testIamPermissions}
+     * @see [Permissions Reference]{@link https://cloud.google.com/pubsub/access_control#permissions}
+     *
+     * @example
+     * ```
+     * const {PubSub} = require('@google-cloud/pubsub');
+     * const pubsub = new PubSub();
+     *
+     * const topic = pubsub.topic('my-topic');
+     * const subscription = topic.subscription('my-subscription');
+     *
+     * //-
+     * // Test a single permission.
+     * //-
+     * const test = 'pubsub.topics.update';
+     *
+     * topic.iam.testPermissions(test, function(err, permissions, apiResponse) {
+     *   console.log(permissions);
+     *   // {
+     *   //   "pubsub.topics.update": true
+     *   // }
+     * });
+     *
+     * //-
+     * // Test several permissions at once.
+     * //-
+     * const tests = [
+     *   'pubsub.subscriptions.consume',
+     *   'pubsub.subscriptions.update'
+     * ];
+     *
+     * subscription.iam.testPermissions(tests, function(err, permissions) {
+     *   console.log(permissions);
+     *   // {
+     *   //   "pubsub.subscriptions.consume": true,
+     *   //   "pubsub.subscriptions.update": false
+     *   // }
+     * });
+     *
+     * //-
+     * // If the callback is omitted, we'll return a Promise.
+     * //-
+     * topic.iam.testPermissions(test).then(function(data) {
+     *   const permissions = data[0];
+     *   const apiResponse = data[1];
+     * });
+     * ```
+     */
     testPermissions(permissions: string | string[], gaxOpts?: CallOptions): Promise<TestIamPermissionsResponse>;
     testPermissions(permissions: string | string[], gaxOpts: CallOptions, callback: TestIamPermissionsCallback): void;
     testPermissions(permissions: string | string[], callback: TestIamPermissionsCallback): void;

package/build/src/iam.js

@@ -50,6 +50,7 @@ const util_1 = require("./util");
  * @see [What is Cloud IAM?]{@link https://cloud.google.com/iam/}
  *
  * @example
+ * ```
  * const {PubSub} = require('@google-cloud/pubsub');
  * const pubsub = new PubSub();
  *
@@ -58,6 +59,7 @@ const util_1 = require("./util");
  *
  * const subscription = pubsub.subscription('my-subscription');
  * // subscription.iam
+ * ```
  */
 class IAM {
     constructor(pubsub, id) {
@@ -65,45 +67,6 @@ class IAM {
         this.request = pubsub.request.bind(pubsub);
         this.id = id;
     }
-    /**
-     * @typedef {array} GetPolicyResponse
-     * @property {object} 0 The policy.
-     */
-    /**
-     * @callback GetPolicyCallback
-     * @param {?Error} err Request error, if any.
-     * @param {object} acl The policy.
-     */
-    /**
-     * Get the IAM policy
-     *
-     * @param {object} [gaxOptions] Request configuration options, outlined
-     *     here: https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html.
-     * @param {GetPolicyCallback} [callback] Callback function.
-     * @returns {Promise<GetPolicyResponse>}
-     *
-     * @see [Topics: getIamPolicy API Documentation]{@link https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics/getIamPolicy}
-     * @see [Subscriptions: getIamPolicy API Documentation]{@link https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.subscriptions/getIamPolicy}
-     *
-     * @example
-     * const {PubSub} = require('@google-cloud/pubsub');
-     * const pubsub = new PubSub();
-     *
-     * const topic = pubsub.topic('my-topic');
-     * const subscription = topic.subscription('my-subscription');
-     *
-     * topic.iam.getPolicy(function(err, policy, apiResponse) {});
-     *
-     * subscription.iam.getPolicy(function(err, policy, apiResponse) {});
-     *
-     * //-
-     * // If the callback is omitted, we'll return a Promise.
-     * //-
-     * topic.iam.getPolicy().then(function(data) {
-     *   const policy = data[0];
-     *   const apiResponse = data[1];
-     * });
-     */
     getPolicy(optsOrCallback, callback) {
         const gaxOpts = typeof optsOrCallback === 'object' ? optsOrCallback : {};
         callback = typeof optsOrCallback === 'function' ? optsOrCallback : callback;
@@ -117,63 +80,6 @@ class IAM {
             gaxOpts,
         }, callback);
     }
-    /**
-     * @typedef {array} SetPolicyResponse
-     * @property {object} 0 The policy.
-     */
-    /**
-     * @callback SetPolicyCallback
-     * @param {?Error} err Request error, if any.
-     * @param {object} acl The policy.
-     */
-    /**
-     * Set the IAM policy
-     *
-     * @throws {Error} If no policy is provided.
-     *
-     * @param {object} policy The [policy](https://cloud.google.com/pubsub/docs/reference/rest/v1/Policy).
-     * @param {array} [policy.bindings] Bindings associate members with roles.
-     * @param {Array<object>} [policy.rules] Rules to be applied to the policy.
-     * @param {string} [policy.etag] Etags are used to perform a read-modify-write.
-     * @param {object} [gaxOptions] Request configuration options, outlined
-     *     here: https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html.
-     * @param {SetPolicyCallback} callback Callback function.
-     * @returns {Promise<SetPolicyResponse>}
-     *
-     * @see [Topics: setIamPolicy API Documentation]{@link https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics/setIamPolicy}
-     * @see [Subscriptions: setIamPolicy API Documentation]{@link https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.subscriptions/setIamPolicy}
-     * @see [Policy]{@link https://cloud.google.com/pubsub/docs/reference/rest/v1/Policy}
-     *
-     * @example
-     * const {PubSub} = require('@google-cloud/pubsub');
-     * const pubsub = new PubSub();
-     *
-     * const topic = pubsub.topic('my-topic');
-     * const subscription = topic.subscription('my-subscription');
-     *
-     * const myPolicy = {
-     *   bindings: [
-     *     {
-     *       role: 'roles/pubsub.subscriber',
-     *       members:
-     * ['serviceAccount:myotherproject@appspot.gserviceaccount.com']
-     *     }
-     *   ]
-     * };
-     *
-     * topic.iam.setPolicy(myPolicy, function(err, policy, apiResponse) {});
-     *
-     * subscription.iam.setPolicy(myPolicy, function(err, policy, apiResponse)
-     * {});
-     *
-     * //-
-     * // If the callback is omitted, we'll return a Promise.
-     * //-
-     * topic.iam.setPolicy(myPolicy).then(function(data) {
-     *   const policy = data[0];
-     *   const apiResponse = data[1];
-     * });
-     */
     setPolicy(policy, optsOrCallback, callback) {
         if (!(typeof policy === 'object')) {
             throw new Error('A policy object is required.');
@@ -191,82 +97,6 @@ class IAM {
             gaxOpts,
         }, callback);
     }
-    /**
-     * @callback TestIamPermissionsCallback
-     * @param {?Error} err Request error, if any.
-     * @param {TestIamPermissionsAPIResponse} permissions A subset of permissions that the caller is allowed.
-     * @param {PermissionsResponse} apiResponse The full API response.
-     */
-    /**
-     * @typedef {array} TestIamPermissionsResponse
-     * @property {object[]} 0 A subset of permissions that the caller is allowed.
-     * @property {PermissionsResponse} 1 The full API response.
-     */
-    /**
-     * @typedef {string[]} PermissionsResponse
-     * A subset of TestPermissionsRequest.permissions that the caller is allowed.
-     * @see https://cloud.google.com/pubsub/docs/reference/rpc/google.iam.v1#google.iam.v1.TestIamPermissionsRequest
-     */
-    /**
-     * Test a set of permissions for a resource.
-     *
-     * Permissions with wildcards such as `*` or `storage.*` are not allowed.
-     *
-     * @throws {Error} If permissions are not provided.
-     *
-     * @param {string|string[]} permissions The permission(s) to test for.
-     * @param {object} [gaxOptions] Request configuration options, outlined
-     *     here: https://googleapis.github.io/gax-nodejs/interfaces/CallOptions.html.
-     * @param {TestIamPermissionsCallback} [callback] Callback function.
-     * @returns {Promise<TestIamPermissionsResponse>}
-     *
-     * @see [Topics: testIamPermissions API Documentation]{@link https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics/testIamPermissions}
-     * @see [Subscriptions: testIamPermissions API Documentation]{@link https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.subscriptions/testIamPermissions}
-     * @see [Permissions Reference]{@link https://cloud.google.com/pubsub/access_control#permissions}
-     *
-     * @example
-     * const {PubSub} = require('@google-cloud/pubsub');
-     * const pubsub = new PubSub();
-     *
-     * const topic = pubsub.topic('my-topic');
-     * const subscription = topic.subscription('my-subscription');
-     *
-     * //-
-     * // Test a single permission.
-     * //-
-     * const test = 'pubsub.topics.update';
-     *
-     * topic.iam.testPermissions(test, function(err, permissions, apiResponse) {
-     *   console.log(permissions);
-     *   // {
-     *   //   "pubsub.topics.update": true
-     *   // }
-     * });
-     *
-     * //-
-     * // Test several permissions at once.
-     * //-
-     * const tests = [
-     *   'pubsub.subscriptions.consume',
-     *   'pubsub.subscriptions.update'
-     * ];
-     *
-     * subscription.iam.testPermissions(tests, function(err, permissions) {
-     *   console.log(permissions);
-     *   // {
-     *   //   "pubsub.subscriptions.consume": true,
-     *   //   "pubsub.subscriptions.update": false
-     *   // }
-     * });
-     *
-     * //-
-     * // If the callback is omitted, we'll return a Promise.
-     * //-
-     * topic.iam.testPermissions(test).then(function(data) {
-     *   const permissions = data[0];
-     *   const apiResponse = data[1];
-     * });
-     */
     testPermissions(permissions, optsOrCallback, callback) {
         if (!Array.isArray(permissions) && !(typeof permissions === 'string')) {
             throw new Error('Permissions are required.');

package/build/src/iam.js.map

@@ -1 +1 @@
-{"version":3,"file":"iam.js","sourceRoot":"","sources":["../../src/iam.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH;;GAEG;AAEH,iCAAkC;AAMlC,iCAAqC;AA8BrC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,MAAa,GAAG;IAKd,YAAY,MAAc,EAAE,EAAU;QACpC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC3C,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;IACf,CAAC;IAKD;;;OAGG;IACH;;;;OAIG;IACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,SAAS,CACP,cAAgD,EAChD,QAA4B;QAE5B,MAAM,OAAO,GAAG,OAAO,cAAc,KAAK,QAAQ,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC;QACzE,QAAQ,GAAG,OAAO,cAAc,KAAK,UAAU,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,QAAQ,CAAC;QAE5E,MAAM,OAAO,GAAG;YACd,QAAQ,EAAE,IAAI,CAAC,EAAE;SAClB,CAAC;QAEF,IAAI,CAAC,OAAO,CACV;YACE,MAAM,EAAE,kBAAkB;YAC1B,MAAM,EAAE,cAAc;YACtB,OAAO;YACP,OAAO;SACR,EACD,QAAS,CACV,CAAC;IACJ,CAAC;IASD;;;OAGG;IACH;;;;OAIG;IACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+CG;IACH,SAAS,CACP,MAAc,EACd,cAAgD,EAChD,QAA4B;QAE5B,IAAI,CAAC,CAAC,OAAO,MAAM,KAAK,QAAQ,CAAC,EAAE;YACjC,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;SACjD;QAED,MAAM,OAAO,GAAG,OAAO,cAAc,KAAK,QAAQ,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC;QACzE,QAAQ,GAAG,OAAO,cAAc,KAAK,UAAU,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,QAAQ,CAAC;QAE5E,MAAM,OAAO,GAAG;YACd,QAAQ,EAAE,IAAI,CAAC,EAAE;YACjB,MAAM;SACP,CAAC;QAEF,IAAI,CAAC,OAAO,CACV;YACE,MAAM,EAAE,kBAAkB;YAC1B,MAAM,EAAE,cAAc;YACtB,OAAO;YACP,OAAO;SACR,EACD,QAAS,CACV,CAAC;IACJ,CAAC;IAeD;;;;;OAKG;IACH;;;;OAIG;IACH;;;;OAIG;IACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2DG;IACH,eAAe,CACb,WAA8B,EAC9B,cAAyD,EACzD,QAAqC;QAErC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,OAAO,WAAW,KAAK,QAAQ,CAAC,EAAE;YACrE,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;SAC9C;QAED,MAAM,OAAO,GAAG,OAAO,cAAc,KAAK,QAAQ,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC;QACzE,QAAQ,GAAG,OAAO,cAAc,KAAK,UAAU,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,QAAQ,CAAC;QAE5E,MAAM,OAAO,GAAG;YACd,QAAQ,EAAE,IAAI,CAAC,EAAE;YACjB,WAAW,EAAE,MAAM,CAAC,WAAW,CAAC;SACjC,CAAC;QAEF,IAAI,CAAC,OAAO,CACV;YACE,MAAM,EAAE,kBAAkB;YAC1B,MAAM,EAAE,oBAAoB;YAC5B,OAAO;YACP,OAAO;SACR,EACD,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;YACZ,IAAI,GAAG,EAAE;gBACP,QAAS,CAAC,GAAG,EAAE,IAAI,EAAE,IAAK,CAAC,CAAC;gBAC5B,OAAO;aACR;YAED,MAAM,oBAAoB,GAAG,MAAM,CAAC,IAAK,CAAC,WAAY,CAAC,CAAC;YACxD,MAAM,cAAc,GAClB,WACD,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,UAAU,EAAE,EAAE;gBAC3B,GAAG,CAAC,UAAU,CAAC,GAAG,oBAAoB,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;gBAChE,OAAO,GAAG,CAAC;YACb,CAAC,EAAE,EAA8B,CAAC,CAAC;YACnC,QAAS,CAAC,IAAI,EAAE,cAAc,EAAE,IAAK,CAAC,CAAC;QACzC,CAAC,CACF,CAAC;IACJ,CAAC;CACF;AAzSD,kBAySC;AAED;;;;;GAKG;AACH,oBAAa,CAAC,GAAG,EAAE,GAAG,CAAC,SAAS,EAAE;IAChC,WAAW;IACX,WAAW;IACX,iBAAiB;CAClB,CAAC,CAAC"}
+{"version":3,"file":"iam.js","sourceRoot":"","sources":["../../src/iam.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH;;GAEG;AAEH,iCAAkC;AAMlC,iCAAqC;AA8BrC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,MAAa,GAAG;IAKd,YAAY,MAAc,EAAE,EAAU;QACpC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC3C,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;IACf,CAAC;IA8CD,SAAS,CACP,cAAgD,EAChD,QAA4B;QAE5B,MAAM,OAAO,GAAG,OAAO,cAAc,KAAK,QAAQ,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC;QACzE,QAAQ,GAAG,OAAO,cAAc,KAAK,UAAU,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,QAAQ,CAAC;QAE5E,MAAM,OAAO,GAAG;YACd,QAAQ,EAAE,IAAI,CAAC,EAAE;SAClB,CAAC;QAEF,IAAI,CAAC,OAAO,CACV;YACE,MAAM,EAAE,kBAAkB;YAC1B,MAAM,EAAE,cAAc;YACtB,OAAO;YACP,OAAO;SACR,EACD,QAAS,CACV,CAAC;IACJ,CAAC;IAoED,SAAS,CACP,MAAc,EACd,cAAgD,EAChD,QAA4B;QAE5B,IAAI,CAAC,CAAC,OAAO,MAAM,KAAK,QAAQ,CAAC,EAAE;YACjC,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;SACjD;QAED,MAAM,OAAO,GAAG,OAAO,cAAc,KAAK,QAAQ,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC;QACzE,QAAQ,GAAG,OAAO,cAAc,KAAK,UAAU,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,QAAQ,CAAC;QAE5E,MAAM,OAAO,GAAG;YACd,QAAQ,EAAE,IAAI,CAAC,EAAE;YACjB,MAAM;SACP,CAAC;QAEF,IAAI,CAAC,OAAO,CACV;YACE,MAAM,EAAE,kBAAkB;YAC1B,MAAM,EAAE,cAAc;YACtB,OAAO;YACP,OAAO;SACR,EACD,QAAS,CACV,CAAC;IACJ,CAAC;IA6FD,eAAe,CACb,WAA8B,EAC9B,cAAyD,EACzD,QAAqC;QAErC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,OAAO,WAAW,KAAK,QAAQ,CAAC,EAAE;YACrE,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;SAC9C;QAED,MAAM,OAAO,GAAG,OAAO,cAAc,KAAK,QAAQ,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC;QACzE,QAAQ,GAAG,OAAO,cAAc,KAAK,UAAU,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,QAAQ,CAAC;QAE5E,MAAM,OAAO,GAAG;YACd,QAAQ,EAAE,IAAI,CAAC,EAAE;YACjB,WAAW,EAAE,MAAM,CAAC,WAAW,CAAC;SACjC,CAAC;QAEF,IAAI,CAAC,OAAO,CACV;YACE,MAAM,EAAE,kBAAkB;YAC1B,MAAM,EAAE,oBAAoB;YAC5B,OAAO;YACP,OAAO;SACR,EACD,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;YACZ,IAAI,GAAG,EAAE;gBACP,QAAS,CAAC,GAAG,EAAE,IAAI,EAAE,IAAK,CAAC,CAAC;gBAC5B,OAAO;aACR;YAED,MAAM,oBAAoB,GAAG,MAAM,CAAC,IAAK,CAAC,WAAY,CAAC,CAAC;YACxD,MAAM,cAAc,GAClB,WACD,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,UAAU,EAAE,EAAE;gBAC3B,GAAG,CAAC,UAAU,CAAC,GAAG,oBAAoB,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;gBAChE,OAAO,GAAG,CAAC;YACb,CAAC,EAAE,EAA8B,CAAC,CAAC;YACnC,QAAS,CAAC,IAAI,EAAE,cAAc,EAAE,IAAK,CAAC,CAAC;QACzC,CAAC,CACF,CAAC;IACJ,CAAC;CACF;AA/SD,kBA+SC;AAED;;;;;GAKG;AACH,oBAAa,CAAC,GAAG,EAAE,GAAG,CAAC,SAAS,EAAE;IAChC,WAAW;IACX,WAAW;IACX,iBAAiB;CAClB,CAAC,CAAC"}

package/build/src/index.d.ts

@@ -29,21 +29,29 @@
  * @module {PubSub} @google-cloud/pubsub
  * @alias nodejs-pubsub
  *
- * @example <caption>Install the client library with <a href="https://www.npmjs.com/">npm</a>:</caption>
+ * @example Install the client library with <a href="https://www.npmjs.com/">npm</a>:
+ * ```
  * npm install @google-cloud/pubsub
  *
- * @example <caption>Import the client library</caption>
+ * ```
+ * @example Import the client library
+ * ```
  * const {PubSub} = require('@google-cloud/pubsub');
  *
- * @example <caption>Create a client that uses <a href="https://cloud.google.com/docs/authentication/production#providing_credentials_to_your_application">Application Default Credentials (ADC)</a>:</caption>
+ * ```
+ * @example Create a client that uses <a href="https://cloud.google.com/docs/authentication/production#providing_credentials_to_your_application">Application Default Credentials (ADC)</a>:
+ * ```
  * const pubsub = new PubSub();
  *
- * @example <caption>Create a client with <a href="https://cloud.google.com/docs/authentication/production#obtaining_and_providing_service_account_credentials_manually">explicit credentials</a>:</caption>
+ * ```
+ * @example Create a client with <a href="https://cloud.google.com/docs/authentication/production#obtaining_and_providing_service_account_credentials_manually">explicit credentials</a>:
+ * ```
  * const pubsub = new PubSub({
  *   projectId: 'your-project-id',
  *   keyFilename: '/path/to/keyfile.json'
  * });
  *
+ * ```
  * @example <caption>include:samples/quickstart.js</caption>
  * region_tag:pubsub_quickstart_create_topic
  * Full quickstart example:

package/build/src/index.js

@@ -32,21 +32,29 @@ exports.protos = exports.v1 = void 0;
  * @module {PubSub} @google-cloud/pubsub
  * @alias nodejs-pubsub
  *
- * @example <caption>Install the client library with <a href="https://www.npmjs.com/">npm</a>:</caption>
+ * @example Install the client library with <a href="https://www.npmjs.com/">npm</a>:
+ * ```
  * npm install @google-cloud/pubsub
  *
- * @example <caption>Import the client library</caption>
+ * ```
+ * @example Import the client library
+ * ```
  * const {PubSub} = require('@google-cloud/pubsub');
  *
- * @example <caption>Create a client that uses <a href="https://cloud.google.com/docs/authentication/production#providing_credentials_to_your_application">Application Default Credentials (ADC)</a>:</caption>
+ * ```
+ * @example Create a client that uses <a href="https://cloud.google.com/docs/authentication/production#providing_credentials_to_your_application">Application Default Credentials (ADC)</a>:
+ * ```
  * const pubsub = new PubSub();
  *
- * @example <caption>Create a client with <a href="https://cloud.google.com/docs/authentication/production#obtaining_and_providing_service_account_credentials_manually">explicit credentials</a>:</caption>
+ * ```
+ * @example Create a client with <a href="https://cloud.google.com/docs/authentication/production#obtaining_and_providing_service_account_credentials_manually">explicit credentials</a>:
+ * ```
  * const pubsub = new PubSub({
  *   projectId: 'your-project-id',
  *   keyFilename: '/path/to/keyfile.json'
  * });
  *
+ * ```
  * @example <caption>include:samples/quickstart.js</caption>
  * region_tag:pubsub_quickstart_create_topic
  * Full quickstart example:

package/build/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH;;GAEG;AACH;;GAEG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AAEH;;;;;;;;;;;GAWG;AAEH;;;;;;;;;;;GAWG;AACH,2BAA2B;AACnB,gBAAE;AAEV,6BAUe;AADb,0FAAA,GAAG,OAAA;AAIL,2DAAuD;AAA/C,6GAAA,YAAY,OAAA;AAEpB,mCAckB;AAFhB,gGAAA,MAAM,OAAA;AAGR,uCAMoB;AADlB,oGAAA,QAAQ,OAAA;AAEV,2CAAwD;AAAhD,qGAAA,OAAO,OAAA;AACf,mCAYkB;AAXhB,gGAAA,MAAM,OAAA;AAIN,qGAAA,WAAW,OAAA;AAIX,qGAAA,WAAW,OAAA;AACX,mGAAA,SAAS,OAAA;AAGX,+CAgBwB;AADtB,4GAAA,YAAY,OAAA;AAEd,iCAciB;AAFf,8FAAA,KAAK,OAAA;AAIP,IAAI,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE;IAC1B,OAAO,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;IAC5C,MAAM,IAAI,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC;IACxC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IACxB,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;CAC/C;AACD,2CAA2C;AACnC,wBAAM"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH;;GAEG;AACH;;GAEG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AAEH;;;;;;;;;;;GAWG;AAEH;;;;;;;;;;;GAWG;AACH,2BAA2B;AACnB,gBAAE;AAEV,6BAUe;AADb,0FAAA,GAAG,OAAA;AAIL,2DAAuD;AAA/C,6GAAA,YAAY,OAAA;AAEpB,mCAckB;AAFhB,gGAAA,MAAM,OAAA;AAGR,uCAMoB;AADlB,oGAAA,QAAQ,OAAA;AAEV,2CAAwD;AAAhD,qGAAA,OAAO,OAAA;AACf,mCAYkB;AAXhB,gGAAA,MAAM,OAAA;AAIN,qGAAA,WAAW,OAAA;AAIX,qGAAA,WAAW,OAAA;AACX,mGAAA,SAAS,OAAA;AAGX,+CAgBwB;AADtB,4GAAA,YAAY,OAAA;AAEd,iCAciB;AAFf,8FAAA,KAAK,OAAA;AAIP,IAAI,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE;IAC1B,OAAO,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;IAC5C,MAAM,IAAI,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC;IACxC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IACxB,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;CAC/C;AACD,2CAA2C;AACnC,wBAAM"}

package/build/src/publisher/flow-publisher.d.ts

@@ -50,14 +50,18 @@ export declare class FlowControlledPublisher {
      * @returns null, or a Promise that resolves when sending may resume.
      *
      * @example
+     * ```
      * const wait = flowControlled.publish({data});
      * if (wait) {
      *   await wait;
      * }
      *
+     * ```
      * @example
+     * ```
      * // It's okay to await unconditionally, it's equivalent to nextTick().
      * await flowControlled.publish(data);
+     * ```
      */
     publish(message: PubsubMessage): Promise<void> | null;
     /**
@@ -70,9 +74,11 @@ export declare class FlowControlledPublisher {
      * @param {Attributes} [attributes] Optional attributes.
      *
      * @example
+     * ```
      * if (!flowControlled.wouldExceed(data)) {
      *   flowControlled.publishNow(data);
      * }
+     * ```
      */
     publishNow(message: PubsubMessage): void;
     private doPublish;

package/build/src/publisher/flow-publisher.js

@@ -55,14 +55,18 @@ class FlowControlledPublisher {
      * @returns null, or a Promise that resolves when sending may resume.
      *
      * @example
+     * ```
      * const wait = flowControlled.publish({data});
      * if (wait) {
      *   await wait;
      * }
      *
+     * ```
      * @example
+     * ```
      * // It's okay to await unconditionally, it's equivalent to nextTick().
      * await flowControlled.publish(data);
+     * ```
      */
     publish(message) {
         const doPublish = () => {
@@ -89,9 +93,11 @@ class FlowControlledPublisher {
      * @param {Attributes} [attributes] Optional attributes.
      *
      * @example
+     * ```
      * if (!flowControlled.wouldExceed(data)) {
      *   flowControlled.publishNow(data);
      * }
+     * ```
      */
     publishNow(message) {
         this.flowControl.addToCount(pubsub_message_1.calculateMessageSize(message), 1);

package/build/src/publisher/flow-publisher.js.map

@@ -1 +1 @@
-{"version":3,"file":"flow-publisher.js","sourceRoot":"","sources":["../../../src/publisher/flow-publisher.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAIH,qDAAqE;AAErE;;;;;;;;;GASG;AACH,MAAa,uBAAuB;IAKlC,YAAY,SAAoB;QAC9B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC;QAC9C,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;IACvB,CAAC;IAED;;;;;;OAMG;IACH,WAAW,CAAC,OAAsB;QAChC,OAAO,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,qCAAoB,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,OAAO,CAAC,OAAsB;QAC5B,MAAM,SAAS,GAAG,GAAG,EAAE;YACrB,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAC1B,CAAC,CAAC;QAEF,MAAM,IAAI,GAAG,qCAAoB,CAAC,OAAO,CAAC,CAAC;QAC3C,IAAI,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE;YACzC,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;YACvD,OAAO,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;SACpC;aAAM;YACL,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;YAClD,SAAS,EAAE,CAAC;YACZ,OAAO,IAAI,CAAC;SACb;IACH,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,UAAU,CAAC,OAAsB;QAC/B,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,qCAAoB,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;QAC9D,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IAC1B,CAAC;IAEO,SAAS,CAAC,OAAsB;QACtC,IAAI,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QAEvD,0CAA0C;QAC1C,MAAM,WAAW,GAAG,CAAC,EAAU,EAAE,EAAE;YACjC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,qCAAoB,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;YACxD,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;QACF,SAAS,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QAC7B,SAAS,GAAG,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAExC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAClC,CAAC;IAED;;;;;;;;OAQG;IACH,GAAG;QACD,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAChD,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QACrB,OAAO,UAAU,CAAC;IACpB,CAAC;CACF;AA1GD,0DA0GC"}
+{"version":3,"file":"flow-publisher.js","sourceRoot":"","sources":["../../../src/publisher/flow-publisher.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAIH,qDAAqE;AAErE;;;;;;;;;GASG;AACH,MAAa,uBAAuB;IAKlC,YAAY,SAAoB;QAC9B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC;QAC9C,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;IACvB,CAAC;IAED;;;;;;OAMG;IACH,WAAW,CAAC,OAAsB;QAChC,OAAO,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,qCAAoB,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,OAAO,CAAC,OAAsB;QAC5B,MAAM,SAAS,GAAG,GAAG,EAAE;YACrB,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAC1B,CAAC,CAAC;QAEF,MAAM,IAAI,GAAG,qCAAoB,CAAC,OAAO,CAAC,CAAC;QAC3C,IAAI,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE;YACzC,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;YACvD,OAAO,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;SACpC;aAAM;YACL,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;YAClD,SAAS,EAAE,CAAC;YACZ,OAAO,IAAI,CAAC;SACb;IACH,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,UAAU,CAAC,OAAsB;QAC/B,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,qCAAoB,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;QAC9D,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IAC1B,CAAC;IAEO,SAAS,CAAC,OAAsB;QACtC,IAAI,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QAEvD,0CAA0C;QAC1C,MAAM,WAAW,GAAG,CAAC,EAAU,EAAE,EAAE;YACjC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,qCAAoB,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;YACxD,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;QACF,SAAS,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QAC7B,SAAS,GAAG,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAExC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAClC,CAAC;IAED;;;;;;;;OAQG;IACH,GAAG;QACD,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAChD,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QACrB,OAAO,UAAU,CAAC;IACpB,CAAC;CACF;AAhHD,0DAgHC"}

package/build/src/publisher/index.d.ts

@@ -64,11 +64,46 @@ export declare class Publisher {
     orderedQueues: Map<string, OrderedQueue>;
     flowControl: FlowControl;
     constructor(topic: Topic, options?: PublishOptions);
+    /**
+     * Immediately sends all remaining queued data. This is mostly useful
+     * if you are planning to call close() on the PubSub object that holds
+     * the server connections.
+     *
+     * @private
+     *
+     * @param {EmptyCallback} [callback] Callback function.
+     * @returns {Promise<EmptyResponse>}
+     */
     flush(): Promise<void>;
     flush(callback: EmptyCallback): void;
+    /**
+     * Publish the provided message.
+     *
+     * @deprecated use {@link Publisher#publishMessage} instead.
+     *
+     * @private
+     * @see Publisher#publishMessage
+     *
+     * @param {buffer} data The message data. This must come in the form of a
+     *     Buffer object.
+     * @param {object.<string, string>} [attributes] Attributes for this message.
+     * @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 the provided message.
+     *
+     * @private
+     *
+     * @throws {TypeError} If data is not a Buffer object.
+     * @throws {TypeError} If any value in `attributes` object is not a string.
+     *
+     * @param {PubsubMessage} [message] Options for this message.
+     * @param {PublishCallback} [callback] Callback function.
+     */
     publishMessage(message: PubsubMessage): Promise<string>;
     publishMessage(message: PubsubMessage, callback: PublishCallback): void;
     /**