interface

TerminalOptions

interface TerminalOptions

Options for creating a pseudo-terminal (PTY).

  • cols?: number

    Number of columns for the terminal.

  • data?: (terminal: Terminal, data: Uint8Array<ArrayBuffer>) => void

    Callback invoked when data is received from the terminal.

  • drain?: (terminal: Terminal) => void

    Callback invoked when the terminal is ready to receive more data.

  • exit?: (terminal: Terminal, exitCode: number, signal: null | string) => void

    Callback invoked when the PTY stream closes (EOF or read error). exitCode is a PTY lifecycle status (0 = clean EOF, 1 = error), NOT the subprocess exit code. Use Subprocess.exited or the onExit callback for the process exit information.

  • name?: string

    Terminal name (e.g., "xterm-256color").

  • rows?: number

    Number of rows for the terminal.