TypeScript API

server.Server.showHooks

TypeScript

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

showHooks ( ) → Promise<ReadonlyMap<string, readonly string[]>> method [source] ¶ method [source] ¶ showHooks

Every global hook tmux currently reports.

A hook is an array of commands, keyed by the name setHook takes, so what was set reads back under the name it was set with. tmux prints each element as name[0], which composes with neither of the writers.

In other ports Read the server's global hooks

Python libtmux.Server.show_hooks
Ruby LibTmux::Server#hooks
Lua libtmux.Server:list_hooks
Rust server.Server.hooks
Go no equivalent on Server
Java io.github.libtmux.Server.Server.hooks
.NET LibTmux.Server.Hooks
C++ libtmux::Server::hooks
Swift Server.hooks(_:)

Examples

TypeScript Python Rust

const hooks = await server.showHooks();
hooks.get("session-created")?.[0];

>>> session.set_hook('session-renamed[0]', 'display-message "test"')
Session($...)

>>> hooks = session.show_hooks()
>>> isinstance(hooks, dict)
True

>>> 'session-renamed[0]' in hooks
True

>>> session.unset_hook('session-renamed')
Session($...)

let guard = libtmux::test::TestServer::new().await?;
let server = guard.server();

server.set_hook("alert-bell", "display-message rang").await?;
let hooks = server.hooks().await?;
assert!(hooks.contains_key("alert-bell"));

guard.shutdown().await?;

0 declared, 0 inherited