decodeWhereDocument
Validate a WHERE document and restore camelCase criteria names.
Source and package
- Qualified name
-
decodeWhere Document - Module
- selection
- Package
- libtmux
- Source
- packages/libtmux/src/selection.ts
-
Description#
The returned document is canonical and deeply frozen.
Examples#
import { decodeWhereDocument } from "libtmux/selection";const document = decodeWhereDocument(JSON.parse('{"model":"pane","version":1,"where":{"pane_title":"logs"}}'),);if (document.model === "pane") snapshot.panes.where(document.where);- Parameters
- Raises
-
-
Query
Validation – when the document or its criteria are invalid.Error
-
Guides#
Pages that discuss decodeWhereDocument.