Core Library0.xAPI Reference

Choose documentation 3

latest

Current version

latest
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

method libtmux-ts latest

Session.showHooks

Every hook this session reports.

Source and package
Qualified name
Session.showHooks
Module
session
Declared in
Session
Package
libtmux
Source
packages/libtmux/src/session.ts
Other languages
Perlmethod Erlang PowerShell Julia Elixir Haskell Common Lisp PythonRubyLuaRustGoJavaC#C++Swift Kotlin Scala OCamlfunction F# Clojure
showHooks(): Promise< ReadonlyMap<string, readonly string[]> >

Description#

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.

Examples#

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

tmux command#

The tmux commands behind showHooks.

tmux C API#

The C declarations in tmux that implement these commands.

tmux hooks#

Events that run tmux commands, with the scope each hook belongs to and where tmux fires it.

In other ports#

Read a session's hooks

Equivalents of Read a session's hooks in other languages
Language Equivalent
Python libtmux.Session.show_hooks
Ruby LibTmux::Session#hooks
Lua libtmux.Session:list_hooks
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
Rust session.Session.hooks
Go tmux.Session.Hooks
Java io.github.libtmux.Session.hooks
C# LibTmux.Session.Hooks
C++ libtmux::Session::hooks
Swift Server.hooks(_:)
OCaml Libtmux_unix.Client.capture_hooks Pass the corresponding explicit Options scope; captured tables preserve their source and inheritance policy.
Perl LibTmux::Server::show_hooks Use an explicit session target ID; raw bytes preserve sparse hook indexes and tmux quoting.

No equivalent is recorded in PowerShell, Julia, Erlang, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.

Esc

Type to search.

Reference previewOpen reference