btwedutech/hoppscotch
5
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 6 Wiki Activity

chore: updated comment for Subscription Type and updated JSDoc for publish

Browse Source
This commit is contained in:
ankitsridhar16
2023-01-19 12:53:40 +05:30
parent 3e9295f313
commit 4aad8d36a9
1 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
packages/hoppscotch-backend/src/subscription-handler.ts
View File

@@ -6,7 +6,7 @@ import { ModuleTypes } from './types/module-types';
// Custom generic type to indicate the type of module // Custom generic type to indicate the type of module
type ModuleType = PrimitiveTypes | ModuleTypes; 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 { enum SubscriptionType {
Created = 'created', Created = 'created',
Updated = 'updated', Updated = 'updated',
@@ -20,7 +20,8 @@ export class SubscriptionHandler {
/** /**
* Publishes a subscription using the pubsub module * 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 * @param moduleType type of the module model being called
* @returns a promise of type void * @returns a promise of type void
*/ */