Skip to content

createTestAdapter

Generated reference page for the createTestAdapter function export.

Signatures

ts
function createTestAdapter(options?: TestAdapterOptions): RuntimeAdapter;
ParameterTypeDescription
optionsTestAdapterOptions | undefinedOptional overrides for any adapter field.

Members

Members

createTestAdapter

Create a test runtime adapter with injectable process state.

Use this in @kjanat/dreamcli/testkit tests when you need to simulate argv, environment variables, TTY state, stdin, or config-file reads without touching the host process.

ts
(options?: TestAdapterOptions): RuntimeAdapter;

Examples

ts
const adapter = createTestAdapter({
  argv: ['node', 'cli.js', 'deploy', '--force'],
  env: { DEPLOY_REGION: 'us' },
});

const result = await cli('mycli').run({ adapter });

See Also

Released under the MIT License.