Syntax

Methods

• Keyboard
  • setKeyboardDelay
  • keyTap
  • keyToggle
  • typeString
• Mouse
  • setMouseDelay
  • moveMouse
  • moveMouseSmooth
  • mouseClick
  • mouseToggle
  • getMousePos
  • scrollMouse
• Screen
  • getPixelColor
  • getScreenSize

---

Keyboard

.setKeyboardDelay(ms)

Sets the delay in milliseconds to sleep after a keyboard event. This is 10ms by default.

Arguments

• ms - Time to sleep in milliseconds.

.keyTap(key, modifier)

Press a single key.

Arguments

• key - Accepts backspace, enter, up, down, left, right, escape, delete, home, end, pageup, pagedown, and a-z.
• modifier (optional) - Accepts alt, command (win), control, and shift.

.keyToggle(key, down, modifier)

Hold down or release a key.

Arguments

• key - Accepts backspace, enter, up, down, left, right, escape, delete, home, end, pageup, pagedown, and a-z.
• down - Accepts down or up.
• modifier (optional) - Accepts alt, command (win), control, and shift.

.typeString(string)

Arguments

• string - the string to send

Mouse

.setMouseDelay(ms)

Sets the delay in milliseconds to sleep after a mouse event. This is 10ms by default.

Arguments

• ms - Time to sleep in milliseconds.

.moveMouse(x, y)

Moves mouse to x, y instantly.

Arguments

• x
• y

Examples

var robot = require("robotjs");

//Move the mouse to 100, 100 on the screen. 
robot.moveMouse(100, 100);

.moveMouseSmooth(x, y)

Moves mouse to x, y human like.

Arguments

• x
• y

.mouseClick(button, double)

Clicks the mouse.

Arguments

• button (optional) - Accepts left, right, or middle. Defaults to left.
• double (optional) - Set to true to perform a double click. Defaults to false.

Examples

var robot = require("robotjs");

robot.mouseClick();

.mouseToggle(down, button)

Toggles mouse button.

Arguments

• down (optional) - Accepts down or up. Defaults to down.
• button (optional) - Accepts left, right, or middle. Defaults to left.

Examples

var robot = require("robotjs");

robot.mouseToggle("down");

setTimeout(function()
{
    robot.mouseToggle("up");

}, 2000);

.getMousePos()

Gets the mouse coordinates.

Return

Returns an object with keys x and y.

Examples

var robot = require("robotjs");

var mouse = robot.getMousePos();
console.log("Mouse is at x:" + mouse.x + " y:" + mouse.y);

.scrollMouse(magnitude, direction)

Scrolls the mouse either up or down.

Arguments

• magnitude - The amount to scroll.
• direction - Accepts down or up.

Examples

var robot = require("robotjs");

robot.scrollMouse(50, "up");

setTimeout(function()
{
    robot.scrollMouse(50, "down");
}, 2000);

Screen

.getPixelColor(x, y)

Gets the pixel color at x, y.

Arguments

• x
• y

Return

Returns the hex color code of the pixel at x, y.

.getScreenSize()

Gets the screen width and height.

Return

Returns an object with .width and .height.