@alexcambose/recjs
Advanced tools
Lightweight user session recorder based on JSON
In browser:
<script src="dist/dist.js"></script>
In Node.js
npm install --save @alexcambose/recjs
import Recjs from 'recjs';
...
<body>
<div id="someElement"></div>
</body>
...
const recjs = new Recjs({
el: '#someElement',
});
recjs.recorder.record(); // starts recording
setTimeout(() => {
recjs.recorder.stop(); // stops recording after 3 seconds
console.log(recjs.recorder.getData()) // gets recording data
}, 3000);
const recjs = new Recjs({
el: '#someElement',
});
recjs.recorder.record(); // starts recording
setTimeout(() => {
recjs.recorder.stop(); // stops recording after 3 seconds
recjs.player.play(recjs.recorder.getData(), () => console.log('Finished')); // plays current recording and logs when finishes
}, 3000);
| Param | Type | Default | Description |
|---|---|---|---|
| $0 | Object | ||
| $0.el | string | Target element that is going to be recorded | |
| [$0.events] | array | ['scroll', 'mousemove', 'keypress', 'click', 'contextmenu'] | User events that will be recorded |
| [$0.fps] | integer | 30 | Number of frames per second |
| [$0.document] | object | window.document | Document object to be used. (in case of an iframe) |
Example
const recjs = new Recjs({
el: '#someElement',
events: ['scroll'],
fps: 60
});
Recorder class
Kind: global class
booleanobject | stringStarts recording
Kind: instance method of Recorder
Example
recjs.recorder.record()
booleanCheck if it is recording
Kind: instance method of Recorder
Returns: boolean - True if it's recording
Example
recjs.recorder.isRecording()
Stops recording
Kind: instance method of Recorder
Example
recjs.recorder.stop()
Pauses current recording
Kind: instance method of Recorder
Example
recjs.recorder.pause()
object | stringReturns recorded data
Kind: instance method of Recorder
| Param | Type | Default |
|---|---|---|
| stringify | boolean | false |
Example
recjs.recorder.getData(true)
Player class
Kind: global class
objectnumberbooleanStarts playing a recording
Kind: instance method of Player
| Param | Type | Description |
|---|---|---|
| data | object | Recorded data |
| onEnd | function | Calls when playing finishes |
Example
recjs.player.play(recjs.recorder.getData(), () => {
console.log('Finished playing')
})
Pauses playing
Kind: instance method of Player
Example
recjs.player.pause()
Stops playing
Kind: instance method of Player
Example
recjs.player.stop()
Set current frame
Kind: instance method of Player
| Param | Type | Description |
|---|---|---|
| index | number | Frame index |
Example
recjs.player.setFrameIndex(87)
objectGet current frame
Kind: instance method of Player
Returns: object - Frame object
Example
recjs.player.currentFrame()
numberGet current frame index
Kind: instance method of Player
Returns: number - Frame index
Example
recjs.player.currentFrameIndex()
booleanIs playing
Kind: instance method of Player
Returns: boolean - Returns true if it is playing
Example
recjs.player.isPlaying()
FAQs
Lightweight user session recorder based on JSON
We found that @alexcambose/recjs demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Following last week’s supply chain attack, Nx published findings on the GitHub Actions exploit and moved npm publishing to Trusted Publishers.
Security News
AGENTS.md is a fast-growing open format giving AI coding agents a shared, predictable way to understand project setup, style, and workflows.
Security News
/Research
Malicious npm package impersonates Nodemailer and drains wallets by hijacking crypto transactions across multiple blockchains.