Interface: LaunchInkFixtureOptions

@termwright/ink

@termwright/ink / LaunchInkFixtureOptions

Interface: LaunchInkFixtureOptions

Defined in: ink/src/fixture.ts:30

Options for launchInkFixture.

Properties

columns?

readonly optional columns?: number

Defined in: ink/src/fixture.ts:44

Terminal width in cells. Default 80.

component

readonly component: string | URL

Defined in: ink/src/fixture.ts:38

The module holding the component: an absolute path or a file: URL.

It is imported by the fixture process, so it must be something Node can load directly — .js/.mjs, or .ts if the fixture runs under a loader passed in LaunchInkFixtureOptions.nodeArgs.

cwd?

readonly optional cwd?: string

Defined in: ink/src/fixture.ts:48

Working directory of the fixture process.

env?

readonly optional env?: Readonly<Record<string, string>>

Defined in: ink/src/fixture.ts:50

Extra environment variables for the fixture process.

envMode?

readonly optional envMode?: EnvMode

Defined in: ink/src/fixture.ts:61

How the fixture’s environment is built, as in launchTerminal. Default 'replace': the process starts from a documented allowlist plus LaunchInkFixtureOptions.env, so a variable on a developer’s laptop cannot change what CI sees.

Unlike a mount, this is real isolation — the fixture is a separate process and its process.env is exactly what the driver built. Pass 'inherit' when the component genuinely needs the runner’s environment.

exportName?

readonly optional exportName?: string

Defined in: ink/src/fixture.ts:40

Export to render. Default default.

logs?

readonly optional logs?: readonly AppLogSource[]

Defined in: ink/src/fixture.ts:67

Log files to follow for the lifetime of the fixture, as in launchTerminal. Entries arrive on the session timeline as app-log events; collectLogs in @termwright/test reads them off the harness.