openreplay/tracker/tracker-redux
Adrian Artiles 8a19dc10cc
Fix typos (#15)
* docs: fix typos

* Update README.md

Co-authored-by: Mehdi Osman <estradino@users.noreply.github.com>
2021-06-04 11:02:53 +02:00
..
src feat: tracker init 2021-05-03 13:31:55 +02:00
.gitignore feat: tracker init 2021-05-03 13:31:55 +02:00
.npmignore feat: tracker init 2021-05-03 13:31:55 +02:00
.prettierrc.json feat: tracker init 2021-05-03 13:31:55 +02:00
LICENSE feat: tracker init 2021-05-03 13:31:55 +02:00
package-lock.json feat: tracker init 2021-05-03 13:31:55 +02:00
package.json feat: tracker init 2021-05-03 13:31:55 +02:00
README.md Fix typos (#15) 2021-06-04 11:02:53 +02:00
tsconfig-cjs.json feat: tracker init 2021-05-03 13:31:55 +02:00
tsconfig.json feat: tracker init 2021-05-03 13:31:55 +02:00

OpenReplay Tracker Redux plugin

A Redux middleware for OpenReplay Tracker. This middleware allows you to see the application state during session replay.

Installation

npm i @openreplay/tracker-redux

Usage

Initialize the @openreplay/tracker package as usual and load the plugin into it. Then put the generated middleware into your Redux chain.

import { applyMiddleware, createStore } from 'redux';
import Tracker from '@openreplay/tracker';
import trackerRedux from '@openreplay/tracker-redux';

const tracker = new Tracker({
  projectKey: YOUR_PROJECT_KEY,
});

const openReplayMiddleware = tracker.use(trackerRedux());

const store = createStore(
  reducer,
  applyMiddleware(openReplayMiddleware),
);

You can customize the middleware behavior with options to sanitize your data.

trackerRedux({
  actionFilter: action => action.type !== 'DRAW', // only actions which pass this test will be recorded
  actionTransformer: action => action.type === 'LOGIN' ? null : action,
  actionType: action => action.type // action type for search, that's the default one
  stateTransformer: state => {
    const { jwt, ..._state } = state;
    return _state;
  },
})