Interface WindowFinderInterface

A WindowFinder should provide an abstraction layer to perform window searches

WindowFinderInterface

interface WindowFinderInterface {
    findMatch(query): Promise<number>;
    findMatches(query): Promise<number[]>;
}

Methods

findMatch findMatches

Methods

findMatch

  • findMatch(query): Promise<number>

  • findMatch should provide an abstraction to search for a window on screen

    Parameters

    • query: {
          by: {
              title: string | RegExp;
          };
          id: string;
          type: "window";
      }

      A WindowQuery containing needed data

      • by: {
            title: string | RegExp;
        }
        • title: string | RegExp
      • id: string
      • type: "window"

    Returns Promise<number>

    A single window handle

    Memberof

    WindowFinderInterface

findMatches

  • findMatches(query): Promise<number[]>

  • findMatches should provide an abstraction to search for a window on screen

    Parameters

    • query: {
          by: {
              title: string | RegExp;
          };
          id: string;
          type: "window";
      }

      A WindowQuery containing needed data

      • by: {
            title: string | RegExp;
        }
        • title: string | RegExp
      • id: string
      • type: "window"

    Returns Promise<number[]>

    A list of window handles

    Memberof

    WindowFinderInterface

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc