nut-js
@nut-tree/shared
Classes
Interfaces
A11yEventDescriptor
ActionabilityOptions
ActionableDescriptor
KeyDownEvent
KeyUpEvent
MouseDownEvent
MouseDragEvent
MouseMoveEvent
MouseUpEvent
MouseWheelEvent
SettledDescriptor
SettledOptions
WindowCreatedEvent
WindowDestroyedEvent
WindowElement
WindowElementDescription
Description for matching window elements.
All properties are optional - only specified properties are matched.
WindowEvent
WindowEventDescriptor
WindowFocusedEvent
WindowHiddenEvent
WindowInterface
WindowMinimizedEvent
WindowMovedEvent
WindowResizedEvent
WindowRestoredEvent
WindowShownEvent
WindowTitleChangedEvent
Functions
a11yEvent
actionable
fromElement
imageToImageJs
isA11yEventDescriptor
isActionableDescriptor
isAtPosition
isButtonEvent
isCharacter
isColorQuery
isFindInput
isImage
isKeyEvent
isLineQuery
isPoint
isRegion
isSettledDescriptor
isSize
isTextQuery
isVisionQuery
isWindowElementQuery
isWindowEventDescriptor
isWindowQuery
isWordQuery
matchAll
matchExactProps
matchStringProps
resolveA11ySignals
resolveWindowSignals
settled
windowEvent
withModifiers
withOwner
withTitle
withWindowId
Types
AccessibilityEvent
AccessibilityEventMatcher
AccessibilityEventSource
AccessibilityEventType
ActionabilityCheck
ColorQuery
A color query is a query that searches for a certain RGBA color on screen.
It will be processed by an ColorFinderInterface instance.
EventMatcher
FindHookCallback
FindInput
FindResult
FocusChangedEvent
LineQuery
A word query is a text query that searches for a single text line on screen.
It will be processed by an TextFinderInterface instance.
MatchResultCallback
MenuCloseEvent
MenuOpenEvent
NameChangedEvent
PointResultFindInput
RegionResultFindInput
SelectionChangedEvent
SettledSignal
TextQuery
TreeChangedEvent
ValueChangedEvent
VisionQuery
A vision query is a query that compares screen content against a natural language description.
It will be processed by a VisionFinderInterface instance.
WindowCallback
WindowedFindInput
WindowedFindResult
WindowElementCallback
WindowElementQuery
A window element query is a query that searches for an element of a window.
It will be processed by an ElementInspectionProviderInterface instance.
WindowElementResultFindInput
WindowEventMatcher
WindowEventType
WindowOwner
WindowOwnerDescription
WindowQuery
A window query is a query that searches for a window on screen.
It will be processed by an WindowFinderInterface instance.
WindowResultFindInput
WindowState
WordQuery
A word query is a text query that searches for a single word on screen.
It will be processed by an TextFinderInterface instance.
Enums
Button
Button enum represents clickable buttons of a mouse
ColorMode
The ColorMode enum is used to specify the color mode of an Image
ExpandCollapseState
FileType
The FileType enum represents the output file type for image data
Key
The Key enum represents keys of a standard 105 key US layout keyboard
Variables
Was this page helpful?