@xterm/addon-search 0.16.0-beta.119 → 0.16.0-beta.120

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xterm/addon-search",
-  "version": "0.16.0-beta.119",
+  "version": "0.16.0-beta.120",
   "author": {
     "name": "The xterm.js authors",
     "url": "https://xtermjs.org/"
@@ -22,7 +22,7 @@
     "start": "node ../../demo/start"
   },
   "peerDependencies": {
-    "@xterm/xterm": "^5.6.0-beta.119"
+    "@xterm/xterm": "^5.6.0-beta.120"
   },
-  "commit": "d7d7f1b0236aaaac17bd707c5e008d4d8701d366"
+  "commit": "ab01a5fd659671ccd5c8c45faa0afe354f09c759"
 }

package/src/SearchAddon.ts

@@ -5,7 +5,7 @@
 
 import type { Terminal, IDisposable, ITerminalAddon, IDecoration } from '@xterm/xterm';
 import type { SearchAddon as ISearchApi } from '@xterm/addon-search';
-import { Emitter } from 'vs/base/common/event';
+import { Emitter, Event } from 'vs/base/common/event';
 import { combinedDisposable, Disposable, dispose, MutableDisposable, toDisposable } from 'vs/base/common/lifecycle';
 
 export interface ISearchOptions {
@@ -31,6 +31,11 @@ export interface ISearchPosition {
   startRow: number;
 }
 
+export interface ISearchResultChangeEvent {
+  resultIndex: number;
+  resultCount: number;
+}
+
 export interface ISearchAddonOptions {
   highlightLimit: number;
 }
@@ -86,8 +91,8 @@ export class SearchAddon extends Disposable implements ITerminalAddon , ISearchA
   private _linesCacheTimeoutId = 0;
   private _linesCacheDisposables = new MutableDisposable();
 
-  private readonly _onDidChangeResults = this._register(new Emitter<{ resultIndex: number, resultCount: number }>());
-  public readonly onDidChangeResults = this._onDidChangeResults.event;
+  private readonly _onDidChangeResults = this._register(new Emitter<ISearchResultChangeEvent>());
+  public get onDidChangeResults(): Event<ISearchResultChangeEvent> { return this._onDidChangeResults.event; }
 
   constructor(options?: Partial<ISearchAddonOptions>) {
     super();

package/typings/addon-search.d.ts

@@ -75,6 +75,21 @@ declare module '@xterm/addon-search' {
     activeMatchColorOverviewRuler: string;
   }
 
+  /**
+   * Event data fired when search results change.
+   */
+  export interface ISearchResultChangeEvent {
+    /**
+     * The index of the currently active result, -1 when the threshold of matches is exceeded.
+     */
+    resultIndex: number;
+
+    /**
+     * The total number of search results found.
+     */
+    resultCount: number;
+  }
+
   /**
    * Options for the search addon.
    */
@@ -139,8 +154,7 @@ declare module '@xterm/addon-search' {
     /**
      * When decorations are enabled, fires when
      * the search results change.
-     * @returns -1 for resultIndex when the threshold of matches is exceeded.
      */
-    readonly onDidChangeResults: IEvent<{ resultIndex: number, resultCount: number }>;
+    readonly onDidChangeResults: IEvent<ISearchResultChangeEvent>;
   }
 }