Core Library0.xAPI Reference

Choose documentation 3

Core Library API reference and guides

Home Guides Topics Concepts Examples API Reference

0.x Released; the API may change. Read more

MCP Tools for connected assistants

Home Guides Topics Examples Tools Prompts Resources API Reference

concept Working example; may change without notice. Read more

Workspace Manager Repeatable development environments

Home Guides Examples CLI Manual API Reference Configuration Internals

concept Working example; may change without notice. Read more

latest

Current version

English

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

Swift API

method libtmux-swift latest

Session.filterFormatField(_:)

The tmux format field an id reads, or nil when it has no single one.

Source and package

Qualified name: Session.filterFormatField(_:)
Declared in: Session
Package: libtmux-swift
Source: Sources/LibTmux/FilterFields.swift

filterFormatField(id: String) -> String?filterFormatField(id: String) -> String? method static overload 2 overloads [source] ¶

Description#

This is what lets a filter be answered by tmux instead of by listing everything and discarding most of it. Returning nil is always safe: the field drops out of the -f predicate and is evaluated in Swift.

Parameters

id (String) #

Reference preview