Type Alias Config<P, Value>`Experimental`

Param type for prompt method config, optionally restricted by prompt slug.

See

type Config<
    P extends Slug = Slug,
    Value extends
        SelectValue = P extends "bool"
        ? boolean
        : P extends "input" ? string : P extends "select" ? SelectValue : never,
> = {
    message: string;
    default?: Value;
    msgArgs?: Partial<MessageMaker.MsgArgs & { timestamp: boolean }>;
    styleClrs?: Partial<node.NodeConsole.Args["styleClrs"]>;
    theme?: RecursivePartial<DefaultTheme>;
    timeout?: number;
}

Type Parameters

P extends Slug = Slug
Value extends SelectValue = P extends "bool"
? boolean
: P extends "input" ? string : P extends "select" ? SelectValue : never

Index

Properties

message default? msgArgs? styleClrs? theme? timeout?

Properties

message

message: string

Prompt message before input.

`Optional`default

default?: Value

Default value, if any.

`Optional`msgArgs

msgArgs?: Partial<MessageMaker.MsgArgs & { timestamp: boolean }>

Optional configuration for output messages while prompting.

`Optional`styleClrs

styleClrs?: Partial<node.NodeConsole.Args["styleClrs"]>

Colours used to style output.

`Optional`theme

theme?: RecursivePartial<DefaultTheme>

`Optional`timeout

timeout?: number

See

NodeConsole_Prompt.Args.timeout