Class NodeConsole_Prompt`Experimental`

Only used by NodeConsole.

Since

2.0.0-alpha

Index

Args

Interactivity

bool input select

Utilities

Misc.

constructor prompt

Args

`Protected` `Readonly` `Experimental`args

args: NodeConsole.Args

A completed args object.

Interactivity

bool

bool(config: BoolConfig): Promise<boolean | undefined>
Experimental
Parameters
- config: BoolConfig
Returns Promise<boolean | undefined>
- Defined in node/classes/NodeConsole/NodeConsole_Prompt.ts:309

input

input(config: InputConfig): Promise<string | undefined>
Experimental
Parameters
- config: InputConfig
Returns Promise<string | undefined>
- Defined in node/classes/NodeConsole/NodeConsole_Prompt.ts:332

select

select<
    Return extends string,
    Config extends
        Omit<SelectConfig<Return>, "choices"> & { choices: Return[] } = Omit<
        SelectConfig<Return>,
        "choices",
    > & { choices: Return[] },
>(
    config: Omit<Config, "theme">,
): Promise<Return | undefined>
Experimental
Type Parameters
- Return extends string
- Config extends Omit<SelectConfig<Return>, "choices"> & { choices: Return[] } = Omit<SelectConfig<Return>, "choices"> & { choices: Return[] }
Parameters
- config: Omit<Config, "theme">
Returns Promise<Return | undefined>
- Defined in node/classes/NodeConsole/NodeConsole_Prompt.ts:351
select<
    Return extends SelectValue,
    Config extends
        Omit<SelectConfig<Return>, "choices"> & {
            choices: {
                value: Return;
                description?: string;
                disabled?: string | boolean;
                name?: string;
                short?: string;
            }[];
        } = Omit<SelectConfig<Return>, "choices"> & {
        choices: {
            value: Return;
            description?: string;
            disabled?: string | boolean;
            name?: string;
            short?: string;
        }[];
    },
>(
    config: Omit<Config, "theme">,
): Promise<Return | undefined>
Experimental
Type Parameters
- Return extends SelectValue
- Config extends Omit<SelectConfig<Return>, "choices"> & {
      choices: {
          value: Return;
          description?: string;
          disabled?: string | boolean;
          name?: string;
          short?: string;
      }[];
  } = Omit<SelectConfig<Return>, "choices"> & {
      choices: {
          value: Return;
          description?: string;
          disabled?: string | boolean;
          name?: string;
          short?: string;
      }[];
  }
Parameters
- config: Omit<Config, "theme">
Returns Promise<Return | undefined>
- Defined in node/classes/NodeConsole/NodeConsole_Prompt.ts:362

Utilities

`Protected` `Readonly` `Experimental`msg

msg: MessageMaker

A local instance of MessageMaker initialized using {@link NodeConsole.Args}.msgMaker.

Misc.

constructor

new NodeConsole_Prompt(
msg: MessageMaker,
args: NodeConsole.Args,
): NodeConsole_Prompt
Experimental
Parameters
- msg: MessageMaker
- args: NodeConsole.Args
  Optional configuration.
Returns NodeConsole_Prompt
- Defined in node/classes/NodeConsole/NodeConsole_Prompt.ts:59

`Protected`prompt

prompt<T_Prompter extends Slug, T_Return extends SelectValue>(
    prompter: T_Prompter,
    run: (
        config: GenericConfig<T_Prompter, T_Return>,
        context?: {
            clearPromptOnDone?: boolean;
            input?: ReadableStream;
            output?: WritableStream;
            signal?: AbortSignal;
        },
    ) => Promise<T_Return>,
    _config: Omit<GenericConfig<T_Prompter, T_Return>, "theme">,
): Promise<T_Return | undefined>
Experimental
Runs a prompter function with some output before and after, if applicable. Also handles and throws errors as applicable.
Type Parameters
- T_Prompter extends Slug
- T_Return extends SelectValue
Parameters
- prompter: T_Prompter
- run: (
      config: GenericConfig<T_Prompter, T_Return>,
      context?: {
          clearPromptOnDone?: boolean;
          input?: ReadableStream;
          output?: WritableStream;
          signal?: AbortSignal;
      },
  ) => Promise<T_Return>
- _config: Omit<GenericConfig<T_Prompter, T_Return>, "theme">
Returns Promise<T_Return | undefined>
- Defined in node/classes/NodeConsole/NodeConsole_Prompt.ts:73