tgui-core 5.4.2 → 5.5.1

package/dist/common/eventbus.d.ts

@@ -11,32 +11,52 @@
  * and update accordingly.
  *
  * @usage
+ *
+ * ### First step
+ *
+ * Create an EventBus with the listeners you want to handle.
+ *
  * ```ts
  * const bus = new EventBus(listeners);
+ *```
  *
- * // These are the event types and their corresponding callbacks.
- * const listeners = {
- *   'messageTypeA': (message) => { logger.log(message.payload); },
- * } as const;
+ * ### Second step
  *
- * // You can further shorten this by linking a function to the event type:
- * function messageTypeA(payload: { text: string }) {
- *  logger.log(payload.text);
- * }
+ * Next, define the listeners object. These are the event types and their
+ * corresponding callbacks.
  *
+ * ```ts
  * const listeners = {
- *   messageTypeA,
+ *   'messageTypeA': handlerA,
  * } as const;
+ *```
+ *
+ * ### Third step
  *
+ * Write a handler for the specific message type.
  *
- * // Later, dispatch a message:
- * const message: ByondMessage = {
- *   type: 'messageTypeA',
- *   payload: { text: 'Hello, world!' },
+ * ```ts
+ * type ExpectedPayloadA = {
+ *   text: string;
  * };
  *
- * bus.dispatch(message);
- * ```
+ * function handlerA(payload: ExpectedPayloadA) {
+ *   logger.log(payload.text);
+ * }
+ *```
+
+ * You can now dispatch the messageTypeA event! If you want to shorten the
+ * syntax, you can name the handler function after the incoming event type.
+ *
+ * ````ts
+ * function messageTypeA(payload: ExpectedPayloadA) {
+ *   logger.log(payload.text);
+ * }
+ *
+ * const listeners = {
+ *  messageTypeA,
+ * } as const;
+ *
  */
 export declare class EventBus<TListeners extends Readonly<Record<string, (payload: unknown) => void>>> {
     private listeners;

package/package.json

@@ -67,5 +67,5 @@
     "test": "bun test"
   },
   "type": "module",
-  "version": "5.4.2"
+  "version": "5.5.1"
 }