TypeScript API

method libtmux-ts latest

Session.setHook

Bind a tmux command to a hook on this session.

Source and package

Qualified name: Session.setHook
Module: session
Declared in: Session
Package: libtmux
Source: packages/libtmux/src/session.ts
Other languages: PowerShell Julia Elixir Python Ruby LuaRustGo Java C# C++Swift Kotlin Scala F#

setHook( name: string, command: string, options?: SetHookOptions, ): Promise<void> method [source] ¶

Description#

A hook holds a list of commands. Without append this writes the whole list, so it replaces whatever the hook already ran.

Examples#

await session.setHook("window-linked", "display-message 'linked'");
await session.setHook("window-linked", "display-message 'twice'", { append: true });

Parameters

tmux command#

The tmux commands behind setHook.

set-hook

tmux C API#

The C declarations in tmux that implement these commands.

cmd_set_hook_entry cmd_set_option_exec

tmux hooks#

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

Hooks

In other ports#

Bind a command to a session hook

Equivalents of Bind a command to a session hook in other languages
Language	Equivalent
Python	`libtmux.Session.set_hook`
Lua	`libtmux.Session:set_hook`
Rust	`session.Session.set_hook`
Go	`tmux.Session.SetHook`
Java	reached through `Session.hooks`, whose `Hooks` carries the write
C#	reached through `Session.Hooks`, whose `TmuxHooks` carries the write
C++	`libtmux::Session::set_hook`
Swift	`Server.setHook(_:to:at:in:)`

No equivalent is recorded in Ruby, PowerShell, Julia, Elixir, Kotlin, Scala or F#.

Scripting & web

Compiled & native

JVM

.NET

BEAM

tmux

Session.setHook

Description#

Examples#

tmux command#

tmux C API#

tmux hooks#

In other ports#

Description#

Examples#

tmux command#

tmux C API#

tmux hooks#

In other ports#

Related types#