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

server.Server.checkAlive

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

View as Markdown

Module
server
Declared in
Server
Package
libtmux
Source
packages/libtmux/src/server.ts
checkAlive ( ) → Promise<void>
method [source]
method [source]
checkAlive

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

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

0 declared, 0 inherited

Esc

Type to search.