JSPM

robotjs-wrapper

0.9.11
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 4
  • Score
    100M100P100Q19184F
  • License ISC

Desktop Automation - Better naming convention for RobotJS, use mouse, keyboard and screen objects.

Package Exports

  • robotjs-wrapper

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (robotjs-wrapper) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

RobotJS-wrapper

More natural Desktop Automation.

What is this?

This is a simple wrapper around RobotJS (https://robotjs.io) that changes it's naming convention. You still can use robotjs naming though.

I provide mouse, keyboard and screen objects with their methods, for exaple:

// RobotJS
robot.scrollMouse(0,0);
robot.mouseClick();

// VS.

// RobotJS-wrapper
robot.mouse.scroll(0,0);
robot.mouse.click();

If you import {mouse}, you can use shorter notation instead:

mouse.scroll(0,0);
mouse.click();

Installation:

Install using Node Package Manager: npm install --save robotjs-wrapper

Usage

import {keybaord,mouse} from 'robotjs-wrapper';
mouse.move(300,300);
mouse.click();
keyboard.type("I am typing!");

Or:

import robot from 'robotjs-wrapper';
robot.mouse.move(300,300);
robot.mouse.click();
robot.keyboard.type("I am typing!");

Mouse

Logging position of a mouse cursor:

import {mouse} from 'robotjs-wrapper';
console.log("Mouse X position:", mouse.x );
console.log("Mouse Y position:", mouse.y );
console.log("Mouse Position:", mouse.position );

Changing only one mouse coordinate:

import {mouse} from 'robotjs-wrapper';
mouse.x = 123;
mouse.y = 456;

Different ways to change mouse position:

mouse.setPos(x,y);
mouse.setPosition(x,y);
mouse.move(x,y);
mouse.pos = {x,y};
mouse.position = {x,y};

Keyboard

Different ways to type:

keyboard.string("I am typing!"); 
keyboard.type("I am typing!");
keyboard.write("I am typing!"); 
keyboard.send("I am typing!");  // AutoHotKey style
keyboard.typeString("I am typing!"); // RobotJS style