PromptBaseQuestion

@tsed/cli-prompts

Usage

import { PromptBaseQuestion } from "@tsed/cli-prompts";

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

Overview

interface PromptBaseQuestion<Value = any> {
    type: PromptType;
    name: string;
    message: string | ((answers: Record<string, any>) => MaybePromise<string>);
    when?: PromptWhen;
    default?: Value | ((answers: Record<string, any>) => MaybePromise<Value>);
    transformer?: PromptTransformer;
    filter?: PromptFilter;
    loop?: boolean;
}

Description

Base contract shared by every question type.

type

type: PromptType;

Prompt type to render.

name

name: string;

Unique answer key assigned to the prompt.

message: string |

message: string | ((answers: Record<string, any>) => MaybePromise<string>);

Prompt label. Accepts a string or function (resolved at runtime).

when

when?: PromptWhen;

Allows skipping the prompt based on previous answers.

default: Value |

default?: Value | ((answers: Record<string, any>) => MaybePromise<Value>);

Default input value or factory function returning one.

transformer

transformer?: PromptTransformer;

Mutates the visual input while the user types.

filter

filter?: PromptFilter;

Mutates the stored answer after validation.

loop

loop?: boolean;

Whether select prompts loop when reaching boundaries.