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.

typealias libtmux-ts latest

TmuxInvocationRequest

What an engine is asked to run: one ordered command list, and the daemon it must still be talking to.

Source and package
Qualified name
TmuxInvocationRequest
Module
engine
Package
libtmux
Source
packages/libtmux/src/engine.ts
type engine.TmuxInvocationRequest = { readonly commands: readonly [TmuxCommand, ...TmuxCommand[]]; readonly daemonGuard?: DaemonGuard; readonly environment?: Readonly<Record<string, string | undefined>>; readonly executable: string; readonly globalArgs: readonly string[]; readonly rawOutput?: true; readonly signal?: AbortLike; readonly stdin?: Uint8Array; readonly timeoutMs?: number; }

Description#

tmux runs a command list until one fails and discards the rest, so the list is the unit of atomicity a caller gets. The daemon guard is what stops a raw tmux id being applied to whatever a restarted server reissued it to.

Esc

Type to search.

Reference previewOpen reference