PromptChoice

@tsed/cli-prompts

Usage

import { PromptChoice } from "@tsed/cli-prompts/src/interfaces/PromptQuestion";

See /packages/cli-prompts/src/interfaces/PromptQuestion.ts.

Overview

type PromptChoice<Value = any> = Option<Value> & {
    name?: string;
    short?: string;
    disabled?: boolean | string;
    checked?: boolean;
};

Description

Represents a single choice entry usable by select, checkbox, and autocomplete prompts.

name

name?: string;

Human friendly label displayed in the prompt list.

short

short?: string;

Optional short label shown beside the main choice name.

disabled

disabled?: boolean | string;

Marks the choice as disabled (boolean or reason string).

checked

checked?: boolean;

For checkbox prompts, marks the choice as checked by default.