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

TmuxInvocationReport

What one tmux invocation cost and how it ended.

Source and package
Qualified name
TmuxInvocationReport
Module
common
Package
libtmux
Source
packages/libtmux/src/common.ts
interface common.TmuxInvocationReport

Description#

Every command this package runs produces one of these, including the four listings behind a snapshot and the probe that reads the version, and including commands a custom engine executed.

Members6#

  • commands: readonly (readonly string[])[] property The commands tmux received, without the connection flags.
  • delivery: DeliveryStatus property How far the command got. replied for one that finished either way.
  • durationMs: number property Wall time from dispatch to answer, excluding any wait for a slot.
  • error: unknown property What the invocation threw, when it did not answer.
  • exitCode: number property tmux's own status, when there was one. Nonzero is a refusal, not a fault.
  • queuedMs: number property Time spent waiting for a slot under maxInFlight.
Esc

Type to search.

Reference previewOpen reference