* fix(ui): fix for messages type from ws * fix(ui): fixes for tab typings, use State instead of array to keep tabs * fix(assist): fixed issue with sessionUpdate event * fix(ui): fix support for old version of assist proto * fix(assist): fixed issue with agent back compatibility * fix(ui): fix assist backwards compat for messages * change(ui): offline-playback text change to recordings * change(ui): offline-playback text change to recordings * fix(assist): added meta header only for sessions from old tracker * fix(ui): fix assist backwards compat for messages * tracker version --------- Co-authored-by: nick-delirium <nikita@openreplay.com> Co-authored-by: Alexander Zavorotynskiy <zavorotynskiy@pm.me> |
||
|---|---|---|
| .. | ||
| scripts | ||
| src | ||
| .eslintignore | ||
| .eslintrc.cjs | ||
| .gitignore | ||
| .npmignore | ||
| .prettierignore | ||
| .prettierrc.json | ||
| CHANGELOG.md | ||
| jest.config.js | ||
| js_errors.txt | ||
| LICENSE | ||
| package.json | ||
| README.md | ||
| rollup.config.js | ||
| tsconfig-base.json | ||
OpenReplay Tracker
The main package of the OpenReplay tracker.
Documentation
For launch options and available public methods, refer to the documentation
Installation
npm i @openreplay/tracker
Usage
Initialize the package from your codebase entry point and start the tracker. You must set the projectKey option in the constructor. Its value can can be found in your OpenReplay dashboard under Preferences -> Projects.
import Tracker from '@openreplay/tracker'
const tracker = new Tracker({
projectKey: YOUR_PROJECT_KEY,
})
tracker
.start({
userID: 'Mr.Smith',
metadata: {
version: '3.5.0',
balance: '10M',
role: 'admin',
},
})
.then((startedSession) => {
if (startedSession.success) {
console.log(startedSession)
}
})
Then you can use OpenReplay JavaScript API anywhere in your code.
tracker.setUserID('my_user_id')
tracker.setMetadata('env', 'prod')