Bardrr NPM | npm.io

Bardrr

Recording Agent for Bard

Bardrr is a node.js package for recording browser events for the bard session replay and analysis tool.

Installation

This is a Node.js module available through the npm registry. Installation is done using the npm install command:

$ npm install bardrr

Initializing the Agent

In order to use the bardrr agent to collect browser events, you must import the Agent from bardrr. Then in your app you need to call the start method on an instance of the agent, passing in an object with an appName, endpoint and MAX_IDLE_TIME. endpoint is where the agent will send the events. MAX_IDLE_TIME is the amount of idle time (in milliseconds) after which a session ends. Example:

import Agent from "bardrr";

new Agent().start({
  appName: "Better Brew",
  endpoint: "http://www.betterbrew.com",
  MAX_IDLE_TIME: 60 * 1000,
});

Custom Events

To trigger and have the Agent handle a custom event you need to import the agent and call the static handleCustomEvent method on it with a custom event type passed in as an argument.

import Agent from "bardrr";

Agent.handleCustomEvent("myCustomEvent");

Additional Configuration

Additional configuration is available through the recordOptions and recordConsolePlugin properties of the object exported by config.js, which are preset to reasonable defaults. Detailed documentation for recordOptions and recordConsolePlugin is available on the rrweb GitHub page, specifically here and here, respectively.