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

TypeScript API

pane.Pane.showHooks

TypeScript

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

View as Markdown

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

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

Read hooks set on this pane itself.

Discussed in Options and hooks

In other ports Read a pane's hooks

Python libtmux.Pane.show_hooks
Ruby LibTmux::Pane#hooks
Lua libtmux.Pane:list_hooks
Rust no whole-table read; Pane.hook reads one
Go tmux.Pane.Hooks
Java io.github.libtmux.Pane.Pane.hooks
.NET LibTmux.Pane.Hooks
C++ no equivalent on Pane
Swift Server.hooks(_:)

Examples

TypeScript Python

const hooks = await pane.showHooks();
hooks.get("pane-title-changed")?.[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($...)

0 declared, 0 inherited