5421aedfe6
* feat tracker moving redux stuff to worker thread * feat ui: sync redux messages to action time * feat ui: starting new redux ui * fix backend mob gen * feat tracker moving redux stuff to worker thread * feat ui: sync redux messages to action time * feat ui: starting new redux ui * fix backend mob gen * styles, third party etc * rm dead code * design fixes * wrapper around old redux stuff * prettier * icon sw * some changes to default style * some code style fixes |
||
|---|---|---|
| .. | ||
| scripts | ||
| src | ||
| .eslintignore | ||
| .eslintrc.cjs | ||
| .gitignore | ||
| .npmignore | ||
| .nvmrc | ||
| .prettierignore | ||
| .prettierrc.json | ||
| bun.lockb | ||
| 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.
Development & Contribution
Please use bun to install and build this library. Any submitted pull request must pass all tests and should have positive test coverage diff %.
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')