docs: add some other missing docs

Im-Beast · Jun 9, 2023 · 626bced · 626bced
1 parent c31f4ea
commit 626bced
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/src/component.ts b/src/component.ts
@@ -21,6 +21,7 @@ export interface ComponentOptions {
   view?: View | undefined | Signal<View | undefined>;
 }
 
+/** Type defining last interaction component experienced */
 export interface Interaction {
   time: number;
   method: "keyboard" | "mouse" | undefined;

diff --git a/src/tui.ts b/src/tui.ts
@@ -18,6 +18,22 @@ export interface TuiOptions {
   refreshRate?: number;
 }
 
+/**
+ * Root element of Tui app.
+ *
+ * This keeps elements running and manages Components as children.
+ *
+ * @example
+ * ```ts
+ * const tui = new Tui({
+ *   style: crayon.bgBlack,
+ *   refreshRate: 1000 / 60,
+ * });
+ *
+ * tui.dispatch();
+ * tui.run();
+ * ```
+ */
 export class Tui extends EventEmitter<
   {
     destroy: EmitterEvent<[]>;