libtmux Reference MCP Search
On this page

server.Server.withConnection

View as Markdown

Module
server
Declared in
Server
Package
@libtmux/libtmux
Source
packages/libtmux/src/server.ts
withConnection ( body : : (live: ConnectedServer) => Promise<T> , options : : ConnectOptions ) Promise<T>
methodasync [source]
methodasync [source]
withConnection

Run body against a connected server, closing it afterwards.

The scoped form of connect , for code that cannot use await using — it needs Symbol.asyncDispose in the consumer's lib — or would rather not manage the lifetime by hand. The connection closes on the way out whether body returns or throws.

Examples

const opened = await server.withConnection(async (live) => {
  await session.newWindow({ name: "build" });
  return live.waitFor((current) => current.windows.exists({ name: "build" }));
});
opened.windows.count({ name: "build" }); // 1

0 declared, 0 inherited

Esc

Type to search.