Merge pull request #26 from vitaly-t/to-consumer

adding method toConsumer

src/event.ts

@@ -1,4 +1,5 @@
 import {Subscription} from './sub';
+import {EventConsumer} from './consumer';
 
 /**
  * Schedule for emitting / broadcasting data to subscribers, to be used by method [[emit]].
@@ -246,6 +247,15 @@ export class SubEvent<T = unknown> {
         this.options = options ?? {};
     }
 
+    /**
+     * Returns a new [[EventConsumer]] for the event, which removes methods [[emit]] and [[cancelAll]].
+     *
+     * This method simplifies creation of a receive-only event object.
+     */
+    public toConsumer<E extends SubEvent<T>>(): EventConsumer<T, E> {
+        return new EventConsumer(this);
+    }
+
     /**
      * Subscribes to the event.
      *

test/event.spec.ts

@@ -1,5 +1,5 @@
 import {chai, dummy, expect} from './';
-import {EmitSchedule, ISubContext, SubEvent} from '../src';
+import {EmitSchedule, EventConsumer, ISubContext, SubEvent} from '../src';
 
 const errInvalidOptions = `Invalid "options" parameter.`;
 
@@ -443,3 +443,14 @@ describe('once', () => {
         expect(contextOut).to.equal(contextIn);
     });
 });
+
+describe('toConsumer', () => {
+    it('must return new EventConsumer', () => {
+        const e = new SubEvent<number>();
+        const c = e.toConsumer();
+        expect(c).to.be.instanceOf(EventConsumer);
+        expect(typeof c.subscribe).to.equal('function');
+        expect((c as any).emit).to.be.undefined;
+        expect((c as any).cancelAll).to.be.undefined;
+    });
+});