CommandOptions.timeoutMs
Give up on the command after this many milliseconds.
Source and package
- Qualified name
-
CommandOptions. timeout Ms - Module
- common
- Declared in
CommandOptions- Package
- libtmux
- Source
- packages/libtmux/src/common.ts
-
Description#
Must be a positive timer-safe integer.
Overrides the server's default, which is 30 seconds unless the server was built with another.
nullremoves the deadline for this call alone.Bounds only this call's own wait. On
["wait-for", "-L", name]in particular, tmux queues a lock request and hands it to the first queued locker regardless of whether that locker is still around to claim it (cmd-wait-for.c) — so a caller whose bounded wait timed out or was cancelled can still be the one tmux is holding the lock for, wedging that channel for every future locker until the process that requested it unlocks it, which a caller that gave up on the wait will never do.