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.

method libtmux-ts latest

TmuxEventStream.ready

Resolve once tmux has accepted the current attach, or reject with its reason.

Source and package
Qualified name
TmuxEventStream.ready
Module
types
Declared in
TmuxEventStream
Package
libtmux
Source
packages/libtmux/src/types.ts
ready(): Promise<void>

Description#

A control client is told nothing that happened before it attached, so a change made between opening the stream and that moment is never announced to it. Await this before making the change you intend to observe, or the wait for it can outlive the event. During reconnect this waits for the replacement client, and rejects if the connection cannot recover.

Esc

Type to search.

Reference previewOpen reference