From 03fcf60aaf71bb2c5c0f830d2cef3303f5617d5f Mon Sep 17 00:00:00 2001
From: Daniel Imms <2193314+Tyriar@users.noreply.github.com>
Date: Sat, 1 Oct 2022 08:55:01 -0700
Subject: [PATCH] Docs

---
 src/common/EventEmitter.ts | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/src/common/EventEmitter.ts b/src/common/EventEmitter.ts
index c0074bba..979a6464 100644
--- a/src/common/EventEmitter.ts
+++ b/src/common/EventEmitter.ts
@@ -66,6 +66,19 @@ export class EventEmitter<T, U = void> implements IEventEmitter<T, U> {
   }
 }
 
+/**
+ * Creates an object that implements both the {@link IEvent} and {@link IEmitter} interfaces. This
+ * allows more concise instantiation. The idea is to internally use the combined
+ * {@link IEventWithEmitter} interface and only expose {@link IEvent} externally.
+ *
+ * @example
+ * ```ts
+ * public readonly onFoo = initEvent<string>();
+ * // ...
+ * onFoo(e => handle(e));
+ * onFoo.fire('bar');
+ * ```
+ */
 export function initEvent<T, U = void>(): IEventWithEmitter<T, U> {
   const emitter = new EventEmitter<T, U>();
   const event = emitter.event;