docs

vitaly-t · Aug 4, 2019 · dcbef1d · dcbef1d
1 parent 69358a4
commit dcbef1d
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/src/event.ts b/src/event.ts
@@ -31,12 +31,16 @@ export interface IEventOptions<T> {
     maxSubs?: number;
 
     /**
-     * Subscription notification callback.
+     * Notification of a new subscriber being registered.
+     *
+     * The callback takes [[ISubContext]] as the only parameter.
      */
     onSubscribe?: (ctx: ISubContext<T>) => void;
 
     /**
-     * Subscription-cancel notification callback.
+     * Notification about a cancelled subscription.
+     *
+     * The callback takes [[ISubContext]] as the only parameter.
      */
     onCancel?: (ctx: ISubContext<T>) => void;
 }