Class Window

Implements

WindowInterface

Index

Constructors

constructor

new Window(providerRegistry, windowHandle): Window
Parameters
- providerRegistry: ProviderRegistry
- windowHandle: number
Returns Window
- Defined in nut.js/lib/window.class.ts:21

Accessors

region

get region(): Promise<Region>
Returns Promise<Region>
- Defined in nut.js/lib/window.class.ts:52

title

get title(): Promise<string>
Returns Promise<string>
- Defined in nut.js/lib/window.class.ts:44

Methods

find

find(searchInput): Promise<WindowElement>
find will search for a single occurrence of a given search input in the current window.
Parameters
- searchInput: {
      by: {
          description: WindowElementDescription;
      };
      id: string;
      type: "window-element";
  } | Promise<{
      by: {
          description: WindowElementDescription;
      };
      id: string;
      type: "window-element";
  }>
  A WindowedFindInput instance
Returns Promise<WindowElement>
Implementation of WindowInterface.find
- Defined in nut.js/lib/window.class.ts:118

findAll

findAll(searchInput): Promise<WindowElement[]>
findAll will search for multiple occurrence of a given search input in the current window.
Parameters
- searchInput: {
      by: {
          description: WindowElementDescription;
      };
      id: string;
      type: "window-element";
  } | Promise<{
      by: {
          description: WindowElementDescription;
      };
      id: string;
      type: "window-element";
  }>
  A WindowedFindInput instance
Returns Promise<WindowElement[]>
Implementation of WindowInterface.findAll
- Defined in nut.js/lib/window.class.ts:156

focus

focus(): Promise<boolean>
Returns Promise<boolean>
Implementation of WindowInterface.focus
- Defined in nut.js/lib/window.class.ts:98

getElements

getElements(maxElements?): Promise<WindowElement>
Parameters
- Optional maxElements: number
Returns Promise<WindowElement>
Implementation of WindowInterface.getElements
- Defined in nut.js/lib/window.class.ts:110

getRegion

getRegion(): Promise<Region>
Returns Promise<Region>
Implementation of WindowInterface.getRegion
- Defined in nut.js/lib/window.class.ts:56

getTitle

getTitle(): Promise<string>
Returns Promise<string>
Implementation of WindowInterface.getTitle
- Defined in nut.js/lib/window.class.ts:48

minimize

minimize(): Promise<boolean>
Returns Promise<boolean>
- Defined in nut.js/lib/window.class.ts:102

move

move(newOrigin): Promise<boolean>
Parameters
- newOrigin: Point
Returns Promise<boolean>
Implementation of WindowInterface.move
- Defined in nut.js/lib/window.class.ts:86

on

on(searchInput, callback): void
on registers a callback which is triggered once a certain searchInput is found
Parameters
- searchInput: {
      by: {
          description: WindowElementDescription;
      };
      id: string;
      type: "window-element";
  }
  to trigger the callback on
  - by: {
    description: WindowElementDescription;
    }
    - description: WindowElementDescription
  - id: string
  - type: "window-element"
- callback: WindowElementCallback
  The FindHookCallback function to trigger
Returns void
Implementation of WindowInterface.on
- Defined in nut.js/lib/window.class.ts:234

resize

resize(newSize): Promise<boolean>
Parameters
- newSize: Size
Returns Promise<boolean>
Implementation of WindowInterface.resize
- Defined in nut.js/lib/window.class.ts:92

restore

restore(): Promise<boolean>
Returns Promise<boolean>
- Defined in nut.js/lib/window.class.ts:106

waitFor

waitFor<PROVIDER_DATA_TYPE>(searchInput, timeoutMs?, updateInterval?, params?): Promise<WindowElement>
waitFor repeatedly searches for a query to appear in the window until it is found or the timeout is reached
Type Parameters
- PROVIDER_DATA_TYPE
Parameters
- searchInput: {
      by: {
          description: WindowElementDescription;
      };
      id: string;
      type: "window-element";
  } | Promise<{
      by: {
          description: WindowElementDescription;
      };
      id: string;
      type: "window-element";
  }>
  A WindowElementQuery instance
- Optional timeoutMs: number
  Timeout in milliseconds after which waitFor fails
- Optional updateInterval: number
  Update interval in milliseconds to retry search
- Optional params: OptionalSearchParameters<PROVIDER_DATA_TYPE>
  OptionalSearchParameters which are used to fine tune search
Returns Promise<WindowElement>
Implementation of WindowInterface.waitFor
- Defined in nut.js/lib/window.class.ts:199

Class Window

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

providerRegistry: ProviderRegistry

windowHandle: number

Returns Window

Accessors

region

Returns Promise<Region>

title

Returns Promise<string>

Methods

find

Parameters

searchInput: { by: { description: WindowElementDescription; }; id: string; type: "window-element"; } | Promise<{ by: { description: WindowElementDescription; }; id: string; type: "window-element"; }>

Returns Promise<WindowElement>

findAll

Parameters

searchInput: { by: { description: WindowElementDescription; }; id: string; type: "window-element"; } | Promise<{ by: { description: WindowElementDescription; }; id: string; type: "window-element"; }>

Returns Promise<WindowElement[]>

focus

Returns Promise<boolean>

getElements

Parameters

Optional maxElements: number

Returns Promise<WindowElement>

getRegion

Returns Promise<Region>

getTitle

Returns Promise<string>

minimize

Returns Promise<boolean>

move

Parameters

newOrigin: Point

Returns Promise<boolean>

on

Parameters

searchInput: { by: { description: WindowElementDescription; }; id: string; type: "window-element"; }

by: { description: WindowElementDescription; }

description: WindowElementDescription

id: string

type: "window-element"

callback: WindowElementCallback

Returns void

resize

Parameters

newSize: Size

Returns Promise<boolean>

restore

Returns Promise<boolean>

waitFor

Type Parameters

PROVIDER_DATA_TYPE

Parameters

searchInput: { by: { description: WindowElementDescription; }; id: string; type: "window-element"; } | Promise<{ by: { description: WindowElementDescription; }; id: string; type: "window-element"; }>

Optional timeoutMs: number

Optional updateInterval: number

Optional params: OptionalSearchParameters<PROVIDER_DATA_TYPE>

Returns Promise<WindowElement>

Settings

Member Visibility

Theme

On This Page

searchInput: {
by: {
description: WindowElementDescription;
};
id: string;
type: "window-element";
} | Promise<{
by: {
description: WindowElementDescription;
};
id: string;
type: "window-element";
}>

searchInput: {
by: {
description: WindowElementDescription;
};
id: string;
type: "window-element";
} | Promise<{
by: {
description: WindowElementDescription;
};
id: string;
type: "window-element";
}>

`Optional` maxElements: number

searchInput: {
by: {
description: WindowElementDescription;
};
id: string;
type: "window-element";
}

by: {
description: WindowElementDescription;
}

searchInput: {
by: {
description: WindowElementDescription;
};
id: string;
type: "window-element";
} | Promise<{
by: {
description: WindowElementDescription;
};
id: string;
type: "window-element";
}>

`Optional` timeoutMs: number

`Optional` updateInterval: number

`Optional` params: OptionalSearchParameters<PROVIDER_DATA_TYPE>