Skip to content

PtyConnectOptions

Options for connecting to a PTY session

Properties:

  • onData() (data: Uint8Array) => void | Promise<void> - Callback to handle PTY output data

    Parameters:

    • data Uint8Array
    Returns

    void | Promise<void>

PtyCreateOptions

Options for creating a PTY session

Properties:

  • cols? number - Number of terminal columns
  • cwd? string - Starting directory for the PTY session, defaults to the sandbox’s working directory
  • envs? Record<string, string> - Environment variables for the PTY session
  • id string - The unique identifier for the PTY session
  • rows? number - Number of terminal rows

PtyResult

PTY session result on exit

Properties:

  • error? string - Error message if the PTY failed
  • exitCode? number - Exit code when the PTY process ends