Skip to content

MultiselectPromptConfig

Multi-selection prompt — maps to array flags. Returns an array of selected SelectChoice values. Part of PromptConfig.

Signatures

ts
interface MultiselectPromptConfig extends PromptConfigBase {}

Members

Properties

choices

Available choices. When omitted for array flags with enum elements, the enum values from the element schema are used automatically.

ts
choices?: readonly SelectChoice[];

kind

Discriminator identifying this as a multi-selection prompt.

ts
kind: "multiselect";

max

Maximum number of selections allowed.

ts
max?: number;

message

The question displayed to the user.

ts
message: string;

min

Minimum number of selections required.

ts
min?: number;

See Also

Released under the MIT License.