Class NodeConsole_PromptExperimental

Protected Readonly Experimentalargs

Protected Readonly Experimentalmsg

Protectedprompt

• prompt<
      Prompter extends Slug,
      Return extends SelectValue,
      Config extends BoolConfig | InputConfig | SelectConfig<Return>,
  >(
      prompter: Prompter,
      run: (
          config: Config,
          context?: {
              clearPromptOnDone?: boolean;
              input?: ReadableStream;
              output?: WritableStream;
              signal?: AbortSignal;
          },
      ) => Promise<Return>,
      _config: Omit<Config, "theme">,
  ): Promise<undefined | Return>
  Experimental

  Runs a prompter function with some output before and after, if applicable. Also handles and throws errors as applicable.

  Type Parameters

  • Prompter extends Slug
  • Return extends SelectValue
  • Config extends BoolConfig | InputConfig | SelectConfig<Return>

  Parameters

  • prompter: Prompter
  • run: (
        config: Config,
        context?: {
            clearPromptOnDone?: boolean;
            input?: ReadableStream;
            output?: WritableStream;
            signal?: AbortSignal;
        },
    ) => Promise<Return>
  • _config: Omit<Config, "theme">

  Returns Promise<undefined | Return>