Class SearchAddon

Searches the complete retained Ghostty buffer and renders visible matches on one canvas.

Implements

TerminalAddon

Index

Constructors

Methods

activate clear dispose findNext findPrevious getMatch onDidChangeResults

Constructors

constructor

new SearchAddon(options?: SearchAddonOptions): SearchAddon
Parameters
- options: SearchAddonOptions = {}
Returns SearchAddon
- Defined in index.ts:101

Methods

activate

activate(terminal: BrowserTerminal): void
Attaches the addon to a terminal. Called by terminal.loadAddon().
Parameters
- terminal: BrowserTerminal
Returns void
Implementation of TerminalAddon.activate
- Defined in index.ts:112

clear

clear(): void
Clears query, indexed matches, active navigation, and highlights.

Returns void
- Defined in index.ts:158

dispose

dispose(): void
Removes the overlay and releases pending work and event subscriptions.

Returns void
Implementation of TerminalAddon.dispose
- Defined in index.ts:179

findNext

findNext(query: string, options?: SearchOptions): Promise<boolean>
Selects the next match in retained-buffer order, wrapping after the final match.
Parameters
- query: string
- options: SearchOptions = {}
Returns Promise<boolean>
- Defined in index.ts:140

findPrevious

findPrevious(query: string, options?: SearchOptions): Promise<boolean>
Selects the previous match in retained-buffer order, wrapping before the first match.
Parameters
- query: string
- options: SearchOptions = {}
Returns Promise<boolean>
- Defined in index.ts:145

getMatch

getMatch(index: number): SearchMatch | undefined
Materializes one completed match without exposing an unbounded result array.
Parameters
- index: number
Returns SearchMatch | undefined
- Defined in index.ts:150

onDidChangeResults

onDidChangeResults(listener: (result: SearchResult) => void): Disposable
Subscribes to search lifecycle and active-match changes.
Parameters
- listener: (result: SearchResult) => void
Returns Disposable
- Defined in index.ts:173