docs

package.json

@@ -1,6 +1,6 @@
 {
   "name": "sub-events",
-  "version": "1.7.4",
+  "version": "1.8.0",
   "description": "Lightweight, strongly-typed events, with monitored subscriptions.",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",

src/consumer.ts

@@ -31,6 +31,9 @@ const pp = new Private<EventConsumer, SubEvent<any>>();
  *     constructor() {
  *        this.safeEvent = new EventConsumer(this.event);
  *
+ *        // or even simpler:
+ *        // this.safeEvent = this.event.toConsumer();
+ *
  *        // clients can only receive data from such "safeEvent",
  *        // they cannot emit data or cancel other subscriptions.
  *     }

src/event.ts

@@ -248,9 +248,18 @@ export class SubEvent<T = unknown> {
     }
 
     /**
-     * Returns a new [[EventConsumer]] for the event, which removes methods [[emit]] and [[cancelAll]].
+     * Returns a new [[EventConsumer]] for the event, which physically hides methods [[emit]] and [[cancelAll]].
      *
-     * This method simplifies creation of a receive-only event object.
+     * This method simplifies creation of a receive-only event object representation.
+     *
+     * ```ts
+     * const e = new SubEvent<number>(); // full-access, emit-receive event
+     *
+     * const c = e.toConsumer(); // the same "e" event, but with receive-only access
+     *
+     * // It is equivalent to the full syntax of:
+     * // const c = new EventConsumer<number>(e);
+     * ```
      */
     public toConsumer<E extends SubEvent<T>>(): EventConsumer<T, E> {
         return new EventConsumer(this);

src/utils/private.ts

@@ -1,5 +1,7 @@
 /**
  * Implements proper private properties.
+ *
+ * @hidden
  */
 export class Private<K extends object, V> {
 

typedoc.json

@@ -1,5 +1,5 @@
 {
-  "name": "SUB-EVENTS v1.7",
+  "name": "SUB-EVENTS v1.8",
   "readme": "README.md",
   "mode": "file",
   "out": "docs",