MouseProviderInterface
A MouseActionProvider should provide access to a systems mouse input
interface MouseProviderInterfaceMethods
click
click(btn: Button): Promise<void>click should allow to perform a single click via OS event
Parameters
Returns
Promise<void>currentMousePosition
currentMousePosition(): Promise<Point>currentMousePosition should return the current mouse pointer position
Returns
Promise<Point>doubleClick
doubleClick(btn: Button): Promise<void>doubleClick should allow to perform a double click via OS event
Parameters
Returns
Promise<void>leftClick
leftClick(): Promise<void>leftClick should allow to perform a left click via OS event
Returns
Promise<void>middleClick
middleClick(): Promise<void>middleClick should allow to perform a middle click via OS event
Returns
Promise<void>pressButton
pressButton(btn: Button): Promise<void>pressButton should allow to press and hold a mouse button
Parameters
Returns
Promise<void>releaseButton
releaseButton(btn: Button): Promise<void>releaseButton should allow to release a pressed button
Parameters
Returns
Promise<void>rightClick
rightClick(): Promise<void>rightClick should allow to perform a right click via OS event
Returns
Promise<void>scrollDown
scrollDown(amount: number): Promise<void>scrollDown should allow to perform an downward mouse scroll
Parameters
amountnumberThe scroll amountReturns
Promise<void>scrollLeft
scrollLeft(amount: number): Promise<void>scrollLeft should allow to perform a left mouse scroll
Parameters
amountnumberThe scroll amountReturns
Promise<void>scrollRight
scrollRight(amount: number): Promise<void>scrollRight should perform a right mouse scroll
Parameters
amountnumberThe scroll amountReturns
Promise<void>scrollUp
scrollUp(amount: number): Promise<void>scrollUp should allow to perform an upward mouse scroll
Parameters
amountnumberThe scroll amountReturns
Promise<void>setMouseDelay
setMouseDelay(delay: number): voidsetMouseDelay should allow to configure mouse movement speed
Parameters
delaynumberThe delay in millisecondssetMousePosition
setMousePosition(p: Point): Promise<void>setMousePosition should allow to set the mouse cursor position
Parameters
Returns
Promise<void>Was this page helpful?