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

ConnectionOptions

Options shared by connected servers and event observers.

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

Members4#

  • bufferSize: number property How many events to hold for a consumer that has fallen behind.
  • reconnect: { readonly attempts: number; readonly delayMs?: number; } property Reopen the connection when it drops unexpectedly.
  • signal: AbortLike property Abort the connection when this signal fires.
  • target: string property Session to attach to. Defaults to whichever tmux considers most recent.
Esc

Type to search.

Reference previewOpen reference