Skip to content

Interface: LocalStreamCheckBuilder<THandle> ​

Defined in: node/src/builders/local-stream-check-builder.ts:29

Fluent builder for a streaming subprocess verification check (local.streamCheck(id)).

Streams stdout and stderr into a combined rolling multi-line buffer, supports early circuit-breaking on failure stack traces, and projects into a post-flight-diffed tool via .asTool().

Extends ​

Type Parameters ​

Type ParameterDefault typeDescription
THandleunknownRuntime handle type of the active isolation scope.

Methods ​

argv() ​

ts
argv(args): LocalStreamCheckBuilder<THandle>;

Defined in: node/src/builders/local-stream-check-builder.ts:54

Binds the command argument vector executed by the streaming check.

Index 0 of args specifies the executable binary and subsequent entries are arguments.

Parameters ​

ParameterTypeDescription
argsreadonly string[]Command argument vector.

Returns ​

LocalStreamCheckBuilder<THandle>

Updated immutable stream check builder.


asTool() ​

ts
asTool(): AstBuilder<LocalStreamCheckToolNode<THandle>> & LocalStreamCheckToolNode<THandle>;

Defined in: node/src/builders/local-stream-check-builder.ts:102

Projects this streaming check into a post-flight-diffed LocalStreamCheckToolNode (type: 'node:stream-check-tool').

Sets effectTracking: 'subprocess-post-flight' and omits describeEffects so workspace mutations performed during a test run are verified post-flight via CheckpointableScope.diffEffects().

Returns ​

AstBuilder<LocalStreamCheckToolNode<THandle>> & LocalStreamCheckToolNode<THandle>

Tool builder and AST descriptor.


circuitBreakWhenStdout() ​

ts
circuitBreakWhenStdout(pattern, options?): LocalStreamCheckBuilder<THandle>;

Defined in: node/src/builders/local-stream-check-builder.ts:89

Configures a rolling-window regular expression circuit breaker over combined stdout and stderr.

When pattern matches across the rolling stream buffer, collects options.graceLinesAfterMatch (defaulting to 25) trailing lines, kills the process group, and fails the check immediately.

Parameters ​

ParameterTypeDescription
patternstring | RegExpRegular expression or pattern string to match.
options?LocalStreamCheckCircuitBreakerOptionsOptional trailing grace line capture configuration.

Returns ​

LocalStreamCheckBuilder<THandle>

Updated immutable stream check builder.


env() ​

ts
env(envVars): LocalStreamCheckBuilder<THandle>;

Defined in: node/src/builders/local-stream-check-builder.ts:65

Binds static string or symbolic EnvRef environment variables injected into the subprocess.

Symbolic EnvRef entries are resolved via ctx.resolveEnv at check invocation time.

Parameters ​

ParameterTypeDescription
envVarsReadonly<Record<string, string | EnvRef>>Environment variable map.

Returns ​

LocalStreamCheckBuilder<THandle>

Updated immutable stream check builder.


runner() ​

ts
runner(runner): LocalStreamCheckBuilder<THandle>;

Defined in: node/src/builders/local-stream-check-builder.ts:43

Binds the NodeRunnerNode pool governing concurrency slots for this streaming check.

Acquires a one-shot command slot via RunnerDriver.withSlot when the check runs.

Parameters ​

ParameterTypeDescription
runnerMaybeBuilder<NodeRunnerNode>Runner pool AST node or builder.

Returns ​

LocalStreamCheckBuilder<THandle>

Updated immutable stream check builder.


timeoutMinutes() ​

ts
timeoutMinutes(minutes): LocalStreamCheckBuilder<THandle>;

Defined in: node/src/builders/local-stream-check-builder.ts:76

Sets the wall-clock timeout in minutes before the streaming subprocess group is terminated.

Sends SIGTERM followed by SIGKILL to the detached process group when the timeout expires.

Parameters ​

ParameterTypeDescription
minutesnumberPositive timeout duration in minutes.

Returns ​

LocalStreamCheckBuilder<THandle>

Updated immutable stream check builder.


toAST() ​

ts
toAST(): LocalStreamCheckNode;

Defined in: core/dist/ast/ast-builder.d.ts:19

Compiles the current builder configuration into a deeply frozen passive AST node.

Validates required builder invariants at compilation time and returns an immutable plain-object AST representation containing zero execution methods.

Returns ​

LocalStreamCheckNode

Deeply frozen passive AST node.

Inherited from ​

AstBuilder.toAST

Properties ​

PropertyModifierTypeDescriptionDefined in
idreadonlystringUnique identifier of the streaming check.node/src/builders/local-stream-check-builder.ts:32

Released under the MIT License.