Version:

nut-js

@nut-tree/nut-js

Classes

class

AssertClass

AssertClass provides methods to assert visibility of search inputs on screen

class

ClipboardClass

class

KeyboardClass

KeyboardClass class provides methods to emulate keyboard input

class

MouseClass

MouseClass class provides methods to emulate mouse input

class

RetryError

class

ScreenClass

ScreenClass class provides methods to access screen content of a systems main display

class

SystemClass

SystemClass provides methods to monitor system-level input events

class

Window

Window represents an OS window and provides methods to interact with it,
such as moving, resizing, focusing, and searching for UI elements within it.

Interfaces

interface

EasingFunction

EasingFunctions are used to modify movement behaviour.

See https://easings.net/ for reference

interface

KeyboardConfig

Config object for KeyboardClass class

interface

MouseConfig

Config object for MouseClass class

interface

RetryContext

interface

RetryOptions

interface

ScreenConfig

Config object for ScreenClass class

Functions

function

centerOf

function

contentMatchingDescription

function

fetchFromUrl

function

imageResource

function

pixelWithColor

function

randomPointIn

function

retry

function

singleWord

function

sleep

function

textLine

function

useConsoleLogger

function

useDefaultClipboardProvider

function

useDefaultKeyboardProvider

function

useDefaultMouseProvider

function

useDefaultProviders

function

useDefaultScreenProvider

function

useDefaultWindowProvider

function

useLogger

function

windowWithTitle

Types

type

BackoffStrategy

Enums

enum

ConsoleLogLevel

Variables

variable

assert

variable

clipboard

variable

down

variable

getActiveWindow

variable

getWindows

variable

jestMatchers

variable

keyboard

variable

left

variable

linear

variable

loadImage

variable

mouse

variable

providerRegistry

variable

right

variable

saveImage

variable

screen

variable

straightTo

variable

system

variable

up

variable

vitestMatchers

Was this page helpful?