npm

lewibs-keylogger

1.0.6 • Public • Published

lewibs-keylogger

This is used to log the keys that the user presses in browser

usage

To use lewibs-keylogger in a project:

  npm install lewibs-keylogger
  import Keylogger from 'lewibs-keylogger';
  
  //activate global
  Keylogger.instance.start();
  
  //or

  //new keylogger instannce
  let logger = new Keylogger();

There are 3 important fields to note:

Keylogger.prototype.pressed which is:

  {
    keynames:bool
  }

Keylogger.prototype.history which is:

  [{
    pressed:{keynames:bool},
    time: unixTimeInt,
    event: Event,
  }]

Keylogger.instance

  Keylogger.instance : new Keylogger();

Additionally there are three prototypes attached:

  start() : which starts logging
  stop(): which pauses the logging
  kill(): which pauses the logging and also removes the history

Overall you get an object which looks like this:

  {
    //privates
    _events: [],
    _running: true,
    
    //public fields
    isKeylogger: true,
    global: Keylogger,
    pressed: {},
    history[],
    
    //public methods
    start: start(),
    stop: stop(),
    kill: kill(),
  }

finally there are four unique keys:

  const WHEEL = "wheel";
  const LEFTMOUSE = "leftmouse";
  const MIDDLEMOUSE = "middlemouse";
  const RIGHTMOUSE = "rightmouse";

test

to test the keylogger run the test dir as a standard react program

Package Sidebar

Install

npm i lewibs-keylogger

Weekly Downloads

1

Version

1.0.6

License

MIT

Unpacked Size

1.22 MB

Total Files

21

Last publish

Collaborators

  • lewibs