Core Library0.xAPI Reference

Choose documentation 1

latest

Current version

latest
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

module libtmux-lua latest

query

Source and package
Qualified name
libtmux.query
Module
libtmux
Package
libtmux
Source
lua/libtmux/query.lua
libtmux.query

Members14#

Common operations6#

  • NULL: libtmux.Null attribute
  • select function @param schema — Required for ordinary sequences.
  • compile function Validate and copy untrusted data; errors are returned rather than raised.
  • decode_json function Decode and validate a complete JSON query; never evaluate received code.
  • encode_json function Encode this Lua API's versioned JSON profile using an explicit consumer codec.
  • where function Validate the entire grammar and required data before selecting records.

Other members8#

  • count function @param schema — Required for ordinary sequences.
  • exists function @param schema — Required for ordinary sequences.
  • filter function Run a trusted local predicate; predicate errors propagate unchanged.
  • first function @param schema — Required for ordinary sequences.
  • iter function @param schema — Required for ordinary sequences.
  • one function @param schema — Required for ordinary sequences.
  • one_or_nil function @param schema — Required for ordinary sequences.
  • to_table function @param schema — Required for ordinary sequences.

Guides#

Pages that discuss query.

Esc

Type to search.

Reference previewOpen reference