nut-js
@nut-tree/provider-interfaces
Interfaces
ClipboardProviderInterface
A ClipboardActionProvider should allow access to the system clipboard
ColorFinderInterface
A WindowFinder should provide an abstraction layer to perform window searches
DataSinkInterface
A DataSink should provide methods to store data
DataSourceInterface
A DataSource should provide methods to load data
ElementInspectionProviderInterface
An ElementInspectionProvider provides methods to list and inspect window elements
ImageFinderInterface
An ImageFinder should provide an abstraction layer to perform image matching
ImageProcessor
An ImageProcessor should provide an abstraction layer to perform
image processing via a 3rd part library
ImageWriterParameters
Parameters for writing an image to disk
InputMonitor
An InputMonitor provides methods to observe system-level input events
such as keyboard and mouse activity
KeyboardProviderInterface
A KeyboardActionProvider should provide access to a systems keyboard
LogProviderInterface
A LogProvider provides structured logging at multiple severity levels
MouseProviderInterface
A MouseActionProvider should provide access to a systems mouse input
ProviderRegistry
A ProviderRegistry manages registration and retrieval of all provider implementations.
It serves as a central service locator for the various system-level providers.
ScreenProviderInterface
A ScreenActionProvider should provide access to a system's main screen
ScreenRecordingProviderInterface
A ScreenRecordingProvider should provide an abstraction layer to control
screen streaming and screen recording.
TextFinderInterface
A TextFinder should provide an abstraction layer to perform text searches
VisionFinderInterface
A VisionFinder should provide an abstraction layer to perform natural language
image matching against screen content.
WindowFinderInterface
A WindowFinder should provide an abstraction layer to perform window searches
WindowProviderInterface
A WindowActionProvider should provide access to a system's window system
Types
ErrorLogFunction
A function that logs an error with optional structured data
ImageReader
ImageWriter
InputEventTypes
Combined event map for all input events
KeyboardInputEvents
Event map for keyboard input events
LogFunction
A function that logs a message with optional structured data
MouseInputEvents
Event map for mouse input events
TypedEmitter
Was this page helpful?