TypeScript API

server.Server.snapshot

TypeScript

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

Module: server
Declared in: Server
Package: libtmux
Source: packages/libtmux/src/server.ts
Other languages: Python Ruby Lua Rust Go Java .NET C++ Swift

snapshot ( options : : SnapshotOptions = {} ) → Promise<ServerSnapshot> method [source] ¶ method [source] ¶ snapshot

Acquire an immutable view of the server at this instant.

Acquisition is the only step that talks to tmux. Everything reachable from the returned value resolves locally, so traversal and filtering issue no commands and an earlier snapshot keeps reporting its own instant.

Examples

const now = await server.snapshot();
now.windows.count();

In other ports Capture the whole hierarchy at one instant

Python no equivalent on Server
Ruby LibTmux::Server#snapshot
Lua libtmux.Server:snapshot
Rust no equivalent on Server
Go tmux.Server.Snapshot
Java io.github.libtmux.Server.Server.snapshot
.NET LibTmux.Server.CaptureSnapshotAsync
C++ no equivalent on Server
Swift Server.snapshot()

0 declared, 0 inherited