StartProcessOptions

StartProcessOptions = object

Defined in: packages/node/src/process/start-process.ts:10

Properties

cwd?

readonly optional cwd?: string | null

Defined in: packages/node/src/process/start-process.ts:17

---

detached?

readonly optional detached?: boolean | null

Defined in: packages/node/src/process/start-process.ts:37

Makes the child lead its own process group, so terminate, kill and an aborted signal reach everything it spawns rather than the child alone.

---

env?

readonly optional env?: NodeJS.ProcessEnv | null

Defined in: packages/node/src/process/start-process.ts:19

---

graceMs?

readonly optional graceMs?: number | null

Defined in: packages/node/src/process/start-process.ts:45

Grace period before terminate escalates to SIGKILL. Default 5000.

---

input?

readonly optional input?: string | Uint8Array | null

Defined in: packages/node/src/process/start-process.ts:25

Written to the child’s stdin, which is then closed.

---

onOutput?

readonly optional onOutput?: Callable<[ProcessOutputStream, string]> | null

Defined in: packages/node/src/process/start-process.ts:40

Pre-subscribed before the child can write anything.

---

shell?

readonly optional shell?: boolean | string | null

Defined in: packages/node/src/process/start-process.ts:15

Runs the command through a shell, so redirection and piping work and arguments are not escaped. Only ever pass a trusted command line.

---

signal?

readonly optional signal?: AbortSignal | null

Defined in: packages/node/src/process/start-process.ts:22

Aborting terminates the child.

---

stderr?

readonly optional stderr?: ProcessStdio | null

Defined in: packages/node/src/process/start-process.ts:31

Default "pipe".

---

stdout?

readonly optional stdout?: ProcessStdio | null

Defined in: packages/node/src/process/start-process.ts:28

Default "pipe", which is what output events are read from.