joro-spider v1.1.1

joro-spider

Joro-spider is a javascript tool for tracking user behaviour while using website. It tracks 3 types of user interactions: click, scroll and presence. Clicks and scrolls are based on event listeners. Presence data generator has a countdown limit, after which it will stop delivering information.

Installation

Use the cdn link

<script src="https://cdn.jsdelivr.net/npm/joro-spider@1.1.1/index_cdn.min.js"></script>

or use the npm

npm install joro-spider

and import content

const createJoro = require('joro-spider');

Usage

// create spider
const joro = createJoro();

// log out data stream
joro.streamData = (data) => {
  console.log({ data });
};

// start spider activity
joro.start();

// stop spider activity
joro.stop();

// check if spider is actively streaming data
console.log(joro.isActive);

Custom configuration

const config = {
  // assign name
  spiderName: 'my spider',
  // throttle scroll data (default 500ms)
  scrollThrottle: 500,
  // throttle presence data (default 1000ms)
  presenceThrottle: 1000,
  // user presence measurements limit using presenceThrottle time units (default 60 pings)
  presencePings: 60,
};

// creates spider
const joro = createJoro(config);

License

MIT