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

common.CommandOptions.timeoutMs

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

View as Markdown

Module
common
Declared in
CommandOptions
Package
libtmux
Source
packages/libtmux/src/common.ts
timeoutMs : : number | null
propertyreadonly [source]
propertyreadonly [source]
timeoutMs

Give up on the command after this many milliseconds.

Must be a positive timer-safe integer.

Overrides the server's default, which is 30 seconds unless the server was built with another. null removes 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.

0 declared, 0 inherited

Esc

Type to search.