Skip to content

Rulvar API reference


Rulvar API reference / @rulvar/executor / ChildSpec

Interface: ChildSpec

Defined in: packages/executor/src/child.ts:13

Properties

PropertyTypeDescriptionDefined in
argsreadonly string[]-packages/executor/src/child.ts:15
commandstring-packages/executor/src/child.ts:14
cwdstring-packages/executor/src/child.ts:23
envRecord<string, string>The child's COMPLETE environment. It replaces the host environment rather than extending it: whatever is not listed here is absent from the child, which is how host credentials in process.env are kept out of the tool.packages/executor/src/child.ts:22
killGraceMsnumberGrace between SIGTERM and the SIGKILL that follows if it ignores it.packages/executor/src/child.ts:29
maxOutputBytesnumberCaptured stdout/stderr are each bounded to this many bytes.packages/executor/src/child.ts:31
signal?AbortSignalCancels the child immediately when it fires (run abort, budget, limits).packages/executor/src/child.ts:33
stdinDatastringWritten to the child's stdin, which is then closed.packages/executor/src/child.ts:25
timeoutMsnumberHard wall-clock ceiling; on expiry the child is SIGTERM'd then SIGKILL'd.packages/executor/src/child.ts:27