TypeScript

Choose a port 16

Scripting & web

PythonNo matching page

RubyNo matching page

LuaNo matching page

JuliaNo matching page

Compiled & native

RustNo matching page

GoNo matching page

C++No matching page

SwiftNo matching page

JVM

JavaNo matching page

KotlinNo matching page

ScalaNo matching page

.NET

C#No matching page

F#No matching page

PowerShellNo matching page

BEAM

ElixirNo matching page

tmux

Packages

Packages and source 9

Source

libtmuxpackages/libtmux libtmux-tslibtmux/libtmux-ts @libtmux/mcppackages/mcp @libtmux/workspacepackages/workspace @libtmux/workspace-clipackages/workspace-cli

Packages

libtmuxnpm @libtmux/mcpnpm @libtmux/workspacenpm @libtmux/workspace-clinpm

TypeScript · libtmux/libtmux-ts

Auto Light Dark

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.

TypeScript API

interface libtmux-ts latest

ClientWhere

Criteria matching a client, evaluated against one snapshot.

Source and package

Qualified name: ClientWhere
Module: selection
Package: libtmux
Source: packages/libtmux/src/selection.ts

interface selection.ClientWhere interface [source] ¶: Description#

Fields given together must all hold. AND, OR and NOT take whole criteria rather than field names, so they nest, and a relation such as some or every is satisfied against the objects the snapshot holds — not against tmux as it stands now.

Members31#

Common operations1#

written: ScalarCriteria<number, RawNumber> property

Other members30#

activity: ScalarCriteria<Date, RawNumber> property
AND: readonly ClientWhere[] property
cellHeight: ScalarCriteria<number, RawNumber> property
cellWidth: ScalarCriteria<number, RawNumber> property
clientSession: ScalarCriteria property
controlMode: ScalarCriteria<boolean, RawFlag> property
created: ScalarCriteria<Date, RawNumber> property
discarded: ScalarCriteria<number, RawNumber> property
flags: ScalarCriteria property
height: ScalarCriteria<number, RawNumber> property
keyTable: ScalarCriteria property
lastSession: ScalarCriteria property
modeFormat: ScalarCriteria property
name: ScalarCriteria property
NOT: readonly ClientWhere[] property
OR: readonly ClientWhere[] property
pane: OneRelation<PaneWhere> property
pid: ScalarCriteria<number, RawNumber> property
prefix: ScalarCriteria<boolean, RawFlag> property
readonly: ScalarCriteria<boolean, RawFlag> property
session: OneRelation<SessionWhere> property
termfeatures: ScalarCriteria property
termname: ScalarCriteria property
termtype: ScalarCriteria property
tty: ScalarCriteria property
uid: ScalarCriteria<number, RawNumber> property
user: ScalarCriteria property
utf8: ScalarCriteria<boolean, RawFlag> property
width: ScalarCriteria<number, RawNumber> property
window: OneRelation<WindowWhere> property

Reference preview