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.

property libtmux-ts latest

ConnectionOptions.reconnect

Reopen the connection when it drops unexpectedly.

Source and package
Qualified name
ConnectionOptions.reconnect
Module
types
Declared in
ConnectionOptions
Package
libtmux
Source
packages/libtmux/src/types.ts
reconnect : { readonly attempts: number; readonly delayMs?: number; }

Description#

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.

Esc

Type to search.

Reference previewOpen reference