Core Library0.xAPI Reference

Choose documentation 3

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.

typealias libtmux-ts latest

StringFilter

A text comparison, of which exactly one form must be given.

Source and package
Qualified name
StringFilter
Module
selection
Package
libtmux
Source
packages/libtmux/src/selection.ts
type selection.StringFilter<Value = never, Raw extends string = string> = StringFilterFields<Value, Raw> & ( | { readonly contains: string } | { readonly endsWith: string } | { readonly equals: Value | Raw | null } | { readonly in: readonly (Value | Raw)[] } | { readonly notIn: readonly (Value | Raw)[] } | { readonly regex: RegexCriteriaData } | { readonly startsWith: string } )

Description#

Written as a union so the type rejects {} — criteria that constrain nothing would match everything, which is never what a caller meant.

Type parameters
Esc

Type to search.

Reference previewOpen reference