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

Server.checkAlive

Assert the server is reachable, raising with tmux's reason if not.

Source and package
Qualified name
Server.checkAlive
Module
server
Declared in
Server
Package
libtmux
Source
packages/libtmux/src/server.ts
checkAlive(): Promise<void>

Description#

Every read already raises on an unreachable server, so this is not what tells an empty result from a missing one — it is the assertion form of isAlive(), for a caller that wants the check and the reason without a read to hang it on.

Examples#

await server.checkAlive(); // throws when no tmux server is listening

tmux command#

The tmux commands behind checkAlive.

tmux C API#

The C declarations in tmux that implement these commands.

Esc

Type to search.

Reference previewOpen reference