@palmetto/pubsub 1.0.3 → 1.0.4

package/dist/subscriber.d.ts

@@ -20,7 +20,17 @@ export declare class Subscriber {
     private readonly subscribedMessages;
     constructor(logger: Logger, providers?: SubscriberProvider[]);
     on<TU extends keyof SubscriberEvents>(event: TU, listener: SubscriberEvents[TU]): this;
-    subscribe<TMessage extends BaseMessage>(config: PubSubConfiguration, onMessage: (msg: TMessage, context: MessageContext) => Promise<MessageResult> | MessageResult): Promise<void>;
+    /**
+     * Starts the subscriber for the given configuration. Depending on the protocol, the subscriber may not be started immediately.
+     *
+     * @param config The pubsub configuration to use for this subscriber
+     * @param onMessage The function to execute when a message arrives
+     * @returns An async function that will unsubscribe the subscriber when called
+     */
+    subscribe<TMessage extends BaseMessage>(config: PubSubConfiguration, onMessage: (msg: TMessage, context: MessageContext) => Promise<MessageResult> | MessageResult): Promise<() => Promise<void>>;
+    /**
+     * Unsubscribes all active subscribers.
+     */
     unsubscribe(): Promise<void>;
     addProvider(provider: SubscriberProvider): void;
     removeProvider(providerOrTransport: SubscriberProvider | string): boolean;

package/dist/subscriber.js

@@ -32,6 +32,13 @@ class Subscriber {
         this.events.on(event, listener);
         return this;
     }
+    /**
+     * Starts the subscriber for the given configuration. Depending on the protocol, the subscriber may not be started immediately.
+     *
+     * @param config The pubsub configuration to use for this subscriber
+     * @param onMessage The function to execute when a message arrives
+     * @returns An async function that will unsubscribe the subscriber when called
+     */
     // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-parameters
     subscribe(config, onMessage) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -98,8 +105,17 @@ class Subscriber {
             subscribedMessage = new SubscribedMessage(yield provider.startSubscribe(config, transform));
             this.subscribedMessages.set(config, subscribedMessage);
             this.logger.log(`Started subscriber for ${config.transport}:${config.name}`);
+            return () => __awaiter(this, void 0, void 0, function* () {
+                this.logger.log(`Stopping subscriber for ${config.transport}:${config.name}`);
+                this.subscribedMessages.delete(config);
+                yield subscribedMessage.stop();
+                this.logger.log(`Stopped subscriber for ${config.transport}:${config.name}`);
+            });
         });
     }
+    /**
+     * Unsubscribes all active subscribers.
+     */
     unsubscribe() {
         return __awaiter(this, void 0, void 0, function* () {
             this.logger.log(`Stopping all ${this.subscribedMessages.size} subscribers`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@palmetto/pubsub",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "main": "./dist/main.js",
   "scripts": {
     "lint": "yarn run -T eslint --fix ./src",