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

wait_for_channel

Change tmux state; no client-supplied executable input. Wait within one deadline for a tmux channel signal.

All Swift tools · JSON · Source

Arguments

channel required · string
Caller-controlled channel.
timeoutMs optional · integer
Caller-controlled timeoutMs.

Schemas

The schema defines required fields, nested values, defaults, and validation constraints.

Input schema
{
"additionalProperties": false,
"properties": {
"channel": {
"description": "Caller-controlled channel.",
"maxLength": 1024,
"type": "string"
},
"timeoutMs": {
"description": "Caller-controlled timeoutMs.",
"maximum": 600000,
"minimum": 100,
"type": "integer"
}
},
"required": [
"channel"
],
"type": "object"
}
Output schema
{
"additionalProperties": false,
"properties": {
"channel": {
"type": "string"
},
"effectiveTimeout": {
"type": "number"
},
"released": {
"type": "boolean"
},
"seconds": {
"type": "number"
}
},
"required": [
"channel",
"effectiveTimeout",
"released",
"seconds"
],
"type": "object"
}
Tool annotations
{
"destructiveHint": true,
"idempotentHint": false,
"openWorldHint": true,
"readOnlyHint": false,
"title": "Wait for channel"
}
Esc

Type to search.