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

RunOptions

How long Server.run lets a program run, and how to stop it early.

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

Members3#

  • separateStderr: boolean property Send the program's stderr to a private file rather than the terminal, and return it as stderr , so output holds stdout alone. stderr is then no terminal, which some programs notice. Like input , it needs the tmux server on this machine.
  • signal: AbortLike property Stop the program when this fires; the call rejects with TmuxTransportError of kind cancelled, the signal's reason as its cause . Its delivery is written once the program had started, which may have done part of its work, and as for SpawnOptions.signal before.
  • timeoutMs: number property Stop the program after this many milliseconds and report what it printed with timedOut set. A positive timer-safe integer; no limit by default.
Esc

Type to search.

Reference previewOpen reference