From 4aad8d36a999379be958db0c1ff265bdda4b66fd Mon Sep 17 00:00:00 2001 From: ankitsridhar16 Date: Thu, 19 Jan 2023 12:53:40 +0530 Subject: [PATCH] chore: updated comment for Subscription Type and updated JSDoc for publish --- packages/hoppscotch-backend/src/subscription-handler.ts | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/packages/hoppscotch-backend/src/subscription-handler.ts b/packages/hoppscotch-backend/src/subscription-handler.ts index f07e62c89..fba5551a4 100644 --- a/packages/hoppscotch-backend/src/subscription-handler.ts +++ b/packages/hoppscotch-backend/src/subscription-handler.ts @@ -6,7 +6,7 @@ import { ModuleTypes } from './types/module-types'; // Custom generic type to indicate the type of module type ModuleType = PrimitiveTypes | ModuleTypes; -// Contains constants for the subscription types we send to pubsub service +// Contains constants for the subscription types we use in Subscription Handler enum SubscriptionType { Created = 'created', Updated = 'updated', @@ -20,7 +20,8 @@ export class SubscriptionHandler { /** * Publishes a subscription using the pubsub module - * @param topic a string containing the module name, a uid and the type of subscription + * @param topic a string containing the module name, an uid and the type of subscription + * @param subscriptionType type of subscription being called * @param moduleType type of the module model being called * @returns a promise of type void */