selection.encodeWhereDocument
TypeScript
- Python Unavailable
- Ruby Unavailable
- Lua Unavailable
- TypeScript
- Rust Unavailable
- Go Unavailable
- Java Unavailable
- .NET Unavailable
- C++ Unavailable
- Swift Unavailable
- Module
- selection
- Package
- libtmux
- Source
- packages/libtmux/src/selection.ts
- encodeWhereDocument ( document : : WhereDocumentV1 ) string
-
Serialize a WHERE document as canonical JSON.
Field names and values use tmux's stable wire spellings. The input is validated without invoking accessors or conversion hooks.
Examples
import { encodeWhereDocument } from "libtmux";const encoded = encodeWhereDocument({model: "pane",version: 1,where: { title: { contains: "log" } },});- Raises
-
-
QueryValidationError – when the document or its criteria are invalid.
-
Discussed in Filtering and queries
0 declared, 0 inherited