createTestPrompter

Generated reference page for the createTestPrompter function export.

• Import: @kjanat/dreamcli/testkit
• Export kind: function
• Declared in: src/core/prompt/index.ts
• Source link: packages/dreamcli/src/core/prompt/index.ts:203

Signatures

function createTestPrompter(answers: readonly unknown[], options?: TestPrompterOptions): PromptEngine;

Parameter	Type	Description
answers	readonly unknown[]	Ordered queue of answers. Use PROMPT_CANCEL for cancellation.
options	TestPrompterOptions | undefined	Controls behavior when the queue is exhausted.

Members

Members

createTestPrompter

Create a prompt engine that returns pre-configured answers.

Each call to promptOne consumes the next answer from the queue. Pass PROMPT_CANCEL as an answer to simulate the user cancelling that prompt.

(answers: readonly unknown[], options?: TestPrompterOptions): PromptEngine;

Examples

const prompter = createTestPrompter(['eu', true, PROMPT_CANCEL]);

// First promptOne → { answered: true, value: 'eu' }
// Second promptOne → { answered: true, value: true }
// Third promptOne → { answered: false }

Related Examples

• Testing examples using @kjanat/dreamcli/testkit. - examples/standalone/testing.ts

See Also

• Examples overview
• Example Hover
• API overview
• @kjanat/dreamcli/testkit