Server.validateLayouts
Check every planned window layout before setup scripts or mutations.
Source and package
- Qualified name
-
server.Server .validate Layouts - Module
- server
- Declared in
- Server
- Package
- libtmux
- Source
- packages/libtmux/src/server.ts
-
Description#
Names accept unique abbreviations. Only version-sensitive layouts query the daemon; a cold endpoint uses the selected client. Checksums, bounded tree structure and pane counts are checked locally; tmux owns geometry and pruning. Custom layouts are limited to 8192 characters and 256 classic groups. JSON layouts require tmux 3.8-rc2 and permit at most 200 nested objects.
Examples#
await server.validateLayouts([{ layout: "even-h", panes: 2 },{ layout: "tiled", panes: 1 },]);- Parameters
- Raises
-
-
Type
Error – when a layout, pane count or version reply is invalid. -
Tmux
Command – when the daemon or client version cannot be read.Error -
Tmux
Transport – when validation is cancelled or a version probe fails.Error
-