Core Library0.xAPI Reference

Choose documentation 3

latest

Current version

latest
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

interface libtmux-ts latest

ProgramResult

What Server.run reports once the program has ended or been stopped.

Source and package
Qualified name
ProgramResult
Module
types
Package
libtmux
Source
packages/libtmux/src/types.ts
interface types.ProgramResult

Members6#

  • lostEnd: boolean property Whether output may lack its end: tmux removed the pane before reading it, or a SIGKILL to the process group left the end unproven. A run that timed out is read before it ends, so this is false and timedOut says why.
  • lostStart: boolean property Whether output lacks its start, which scrolled past historyLimit .
  • output: string property What the program printed, as its terminal shows it, scrollback included: NUL and other control bytes are dropped and wrapped lines joined. For the bytes as written, use Server.spawn with stream: true.
  • stderr: string property What the program wrote to stderr, as written, when separateStderr was set.
  • success: boolean property Whether the program exited with status 0.
  • timedOut: boolean property Whether timeoutMs stopped the program; its exit fields are then null.
Esc

Type to search.

Reference previewOpen reference