encodeWhereDocument
Serialize a WHERE document as canonical JSON.
Source and package
- Qualified name
-
encodeWhere Document - Module
- selection
- Package
- libtmux
- Source
- packages/libtmux/src/selection.ts
-
Description#
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" } },});- Parameters
- Raises
-
-
Query
Validation – when the document or its criteria are invalid.Error
-
Guides#
Pages that discuss encodeWhereDocument.