MenuEvents

The MenuEvents interface defines the event map for a menu component in ts-better-console. It describes the events that can be emitted by a menu, allowing you to respond to user selections and exits.

Type Definition

The MenuEvents interface includes the following events:

• select: Emitted when the user selects a menu item. Provides the label (string) of the selected item and its index (number) within the menu.
• exit: Emitted when the user exits the menu. No arguments are passed.

interface MenuEvents {
  select: [label: string, index: number];
  exit: [];
}

Usage

You can listen to MenuEvents when using a menu to handle user interactions:

import { Menu } from "ts-better-console";

const m = new Menu([
{ label: "Option 1" },
{ label: "Option 2" },
{ label: "Option 3" },
]);

m.on("select", (label, index) => {
console.log(`Selected: ${label} at index ${index}`);
m.destroy();
});

m.on("exit", () => {
console.log("Menu closed");
});

m.show();