up([options])

Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Open source

up([options])

Dispatches a mouseup event on the mouse’s current position. Mouse’s current position can be changed using mouse.move().

ParameterTypeDescription
optionsobjectOptional.
options.buttonstringThe mouse button to click. Possible values are 'left', 'right', and 'middle'. Default is 'left'.
options.clickCountnumberThe number of times to click. Default is 1.

Returns

TypeDescription
Promise<void>A Promise that fulfills when the mouse up action is complete.