On this page

selection.encodeWhereDocument

Module: selection
Package: @libtmux/libtmux
Source: packages/libtmux/src/selection.ts

encodeWhereDocument ( document : : WhereDocumentV1 ) → string function [source] ¶ function [source] ¶ encodeWhereDocument

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.

0 declared, 0 inherited