nut-js
@nut-tree/shared
Classes
Interfaces
KeyDownEvent
KeyUpEvent
MouseDownEvent
MouseDragEvent
MouseMoveEvent
MouseUpEvent
MouseWheelEvent
WindowElement
WindowElementDescription
Description for matching window elements.
All properties are optional - only specified properties are matched.
WindowInterface
Functions
imageToImageJs
isAtPosition
isButtonEvent
isCharacter
isColorQuery
isImage
isKeyEvent
isLineQuery
isPoint
isRegion
isSize
isTextQuery
isVisionQuery
isWindowElementQuery
isWindowQuery
isWordQuery
withModifiers
Types
ColorQuery
A color query is a query that searches for a certain RGBA color on screen.
It will be processed by an ColorFinderInterface instance.
FindHookCallback
FindInput
FindResult
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
PointResultFindInput
RegionResultFindInput
TextQuery
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
WindowQuery
A window query is a query that searches for a window on screen.
It will be processed by an WindowFinderInterface instance.
WindowResultFindInput
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
Was this page helpful?