Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

TypeScript API

types.ConnectionOptions.reconnect

TypeScript

Python Unavailable
Ruby Unavailable
Lua Unavailable
TypeScript
Rust Unavailable
Go Unavailable
Java Unavailable
.NET Unavailable
C++ Unavailable
Swift Unavailable

View as Markdown

Module: types
Declared in: ConnectionOptions
Package: libtmux
Source: packages/libtmux/src/types.ts

reconnect : : { /** Maximum retries per outage. A positive safe integer. */ readonly attempts: number; /** Nonnegative base milliseconds; retry N waits N times this value. Defaults to 50. */ readonly delayMs?: number; }

propertyreadonly [source] ¶

propertyreadonly [source] ¶

reconnect: Reopen the connection when it drops unexpectedly.

Off by default: a stream that silently reattaches hides a tmux server going away, and a caller that wants to know cannot get the notice back. When enabled, a recovered connection reports itself as a reconnected event so a consumer can tell that it missed whatever happened in the gap.
A reconnect restores event delivery; commands use separate tmux clients.

0 declared, 0 inherited