@quatrain/queue-gcp 1.1.25 → 1.2.1-pr25.5739

package/dist/GcpPubsubAdapter.d.ts

@@ -1,6 +1,22 @@
 import { AbstractQueueAdapter, QueueParameters } from '@quatrain/queue';
+/**
+ * Google Cloud Platform Pub/Sub compatible queue adapter interface.
+ */
 export declare class PubSubQueueAdapter extends AbstractQueueAdapter {
     constructor(params: QueueParameters);
+    /**
+     * Publishes data buffer as a Pub/Sub topic push.
+     *
+     * @param data - The data payload.
+     * @param topic - The GCP Topic identifier.
+     * @returns GCP topic tracking message ID.
+     */
     send(data: any, topic: string): Promise<string>;
+    /**
+     * Hooks onto the onPublish listener system for internal pub/sub logic tracking.
+     *
+     * @param topic - Destination topic.
+     * @returns The GCP listener handler loop.
+     */
     listen(topic: string): any;
 }

package/dist/GcpPubsubAdapter.js

@@ -13,6 +13,9 @@ exports.PubSubQueueAdapter = void 0;
 const core_1 = require("@quatrain/core");
 const queue_1 = require("@quatrain/queue");
 const pubsub_1 = require("@google-cloud/pubsub");
+/**
+ * Google Cloud Platform Pub/Sub compatible queue adapter interface.
+ */
 class PubSubQueueAdapter extends queue_1.AbstractQueueAdapter {
     constructor(params) {
         super(params);
@@ -22,6 +25,13 @@ class PubSubQueueAdapter extends queue_1.AbstractQueueAdapter {
             keyFilename,
         });
     }
+    /**
+     * Publishes data buffer as a Pub/Sub topic push.
+     *
+     * @param data - The data payload.
+     * @param topic - The GCP Topic identifier.
+     * @returns GCP topic tracking message ID.
+     */
     send(data, topic) {
         return __awaiter(this, void 0, void 0, function* () {
             const dataBuffer = Buffer.from(JSON.stringify(data));
@@ -30,6 +40,12 @@ class PubSubQueueAdapter extends queue_1.AbstractQueueAdapter {
             return messageId;
         });
     }
+    /**
+     * Hooks onto the onPublish listener system for internal pub/sub logic tracking.
+     *
+     * @param topic - Destination topic.
+     * @returns The GCP listener handler loop.
+     */
     listen(topic) {
         return this._client.topic(topic).onPublish();
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quatrain/queue-gcp",
-  "version": "1.1.25",
+  "version": "1.2.1-pr25.5739",
   "description": "Queue adapter for Google Cloud Platform PubSub",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -34,13 +34,16 @@
   },
   "dependencies": {
     "@google-cloud/pubsub": "^4.7.0",
-    "@quatrain/core": "^1.1.52",
-    "@quatrain/queue": "^1.1.32"
+    "@quatrain/core": "^1.2.18",
+    "@quatrain/queue": "^1.2.3"
   },
   "scripts": {
     "test-ci": "jest --runInBand",
     "build": "tsc",
     "wbuild": "tsc --watch",
     "bump-to": "yarn version"
+  },
+  "typedoc": {
+    "entryPoint": "src/index.ts"
   }
 }

package/src/GcpPubsubAdapter.ts

@@ -2,6 +2,9 @@ import { Core } from '@quatrain/core'
 import { AbstractQueueAdapter, QueueParameters } from '@quatrain/queue'
 import { PubSub } from '@google-cloud/pubsub'
 
+/**
+ * Google Cloud Platform Pub/Sub compatible queue adapter interface.
+ */
 export class PubSubQueueAdapter extends AbstractQueueAdapter {
    constructor(params: QueueParameters) {
       super(params)
@@ -13,6 +16,13 @@ export class PubSubQueueAdapter extends AbstractQueueAdapter {
       })
    }
 
+   /**
+    * Publishes data buffer as a Pub/Sub topic push.
+    * 
+    * @param data - The data payload.
+    * @param topic - The GCP Topic identifier.
+    * @returns GCP topic tracking message ID.
+    */
    async send(data: any, topic: string): Promise<string> {
       const dataBuffer = Buffer.from(JSON.stringify(data))
       const messageId = await this._client.topic(topic).publish(dataBuffer)
@@ -22,6 +32,12 @@ export class PubSubQueueAdapter extends AbstractQueueAdapter {
       return messageId
    }
 
+   /**
+    * Hooks onto the onPublish listener system for internal pub/sub logic tracking.
+    * 
+    * @param topic - Destination topic.
+    * @returns The GCP listener handler loop.
+    */
    listen(topic: string) {
       return this._client.topic(topic).onPublish()
    }