@runloop/agent-axon-client
    Preparing search index...

    Interface SpawnedProcess

    Represents a spawned process with stdin/stdout streams and lifecycle management. Implementers provide this interface to abstract the process spawning mechanism. ChildProcess already satisfies this interface.

    interface SpawnedProcess {
        exitCode: number | null;
        killed: boolean;
        stdin: Writable;
        stdout: Readable;
        kill(signal: Signals): boolean;
        off(
            event: "exit",
            listener: (code: number | null, signal: Signals | null) => void,
        ): void;
        off(event: "error", listener: (error: Error) => void): void;
        on(
            event: "exit",
            listener: (code: number | null, signal: Signals | null) => void,
        ): void;
        on(event: "error", listener: (error: Error) => void): void;
        once(
            event: "exit",
            listener: (code: number | null, signal: Signals | null) => void,
        ): void;
        once(event: "error", listener: (error: Error) => void): void;
    }
    Index

    Claude SDK

    exitCode killed stdin stdout kill off on once

    Claude SDK

    exitCode: number | null

    Exit code if the process has exited, null otherwise

    killed: boolean

    Whether the process has been killed

    stdin: Writable

    Writable stream for sending data to the process stdin

    stdout: Readable

    Readable stream for receiving data from the process stdout

    • Kill the process with the given signal

      Parameters

      • signal: Signals

        The signal to send (e.g., 'SIGTERM', 'SIGKILL')

      Returns boolean

    • Remove an event listener

      Parameters

      • event: "exit"
      • listener: (code: number | null, signal: Signals | null) => void

      Returns void

    • Parameters

      • event: "error"
      • listener: (error: Error) => void

      Returns void

    • Register a callback for when the process exits

      Parameters

      • event: "exit"

        Must be 'exit'

      • listener: (code: number | null, signal: Signals | null) => void

        Callback receiving exit code and signal

      Returns void

    • Register a callback for process errors

      Parameters

      • event: "error"

        Must be 'error'

      • listener: (error: Error) => void

        Callback receiving the error

      Returns void

    • Register a one-time callback for when the process exits

      Parameters

      • event: "exit"
      • listener: (code: number | null, signal: Signals | null) => void

      Returns void

    • Parameters

      • event: "error"
      • listener: (error: Error) => void

      Returns void

    Settings

    Member Visibility

    On This Page

    Claude SDK