TypeScript API

method libtmux-ts latest

TmuxEventStream.find

Resolve with the first event matches accepts, or undefined if the deadline passes or the stream is closed first.

Source and package

Qualified name: TmuxEventStream.find
Module: types
Declared in: TmuxEventStream
Package: libtmux
Source: packages/libtmux/src/types.ts

find<Match extends TmuxEvent>( matches: (event: TmuxEvent) => event is Match, options?: { readonly timeoutMs?: number }, ): Promise<Match | undefined>find( matches: (event: TmuxEvent) => unknown, options?: { readonly timeoutMs?: number }, ): Promise<TmuxEvent | undefined> method overload 2 overloads [source] ¶

Description#

This consumes the stream, which is what iterating it does anyway. It exists because every caller otherwise writes the same loop, deadline, and cleanup, and forgetting the deadline turns a missed event into a hang.

Type parameters

Match # for find(matches, options) [overload 1]

Bound TmuxEvent

Parameters

matches ((event: TmuxEvent) => event is Match) # for find(matches, options) [overload 1]
options? ({ readonly timeoutMs?: number }) #
matches ((event: TmuxEvent) => unknown) # for find(matches, options) [overload 2]

Raises

LibTmuxError – when the stream ends under the wait — the server went away, or the connection dropped. Closing it on purpose is not that: a caller cancelling, or a scope ending, answers undefined, because deciding to stop waiting is not a failure anyone should have to catch. Undefined therefore means the deadline passed or the wait was called off, and only the deadline says the workload really did not print what was waited for. timeoutMs, when set, must be a positive timer-safe integer. for find(matches, options) [overload 1]

Scripting & web

Compiled & native

JVM

.NET

BEAM

tmux

TmuxEventStream.find

Description#

Description#

Related types#