Symbol

ReadableSyncSubprocess

type ReadableSyncSubprocess = SyncSubprocess<'pipe', 'pipe'>

Utility type for any process from () with both stdout and stderr set to "pipe"

Referenced types

interface SyncSubprocess<Out extends SpawnOptions.Readable, Err extends SpawnOptions.Readable>

A process created by Bun.spawnSync.

This type accepts 2 optional type parameters which correspond to the stdout and stderr options. Instead of specifying these, you should use one of the following utility types instead:

ReadableSyncSubprocess (pipe, pipe)
NullSyncSubprocess (ignore, ignore)

exitCode: number
exitedDueToMaxBuffer?: boolean
exitedDueToTimeout?: boolean
pid: number
resourceUsage: ResourceUsage
Get the resource usage information of the process (max RSS, CPU time, etc)
signalCode?: string
stderr: ReadableToSyncIO<Err>
stdout: ReadableToSyncIO<Out>
success: boolean