recjs


Lightweight user session recorder based on JSON

Installation

In browser:

``html

`

In Node.js

`bash
npm install --save @alexcambose/recjs
`

`javascript
import Recjs from 'recjs';
`

Usage

`html
...





...
`

$3

`javascript
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);
`

$3

`javascript
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);
`

API Reference

Classes

Recjs

Recorder

Recorder class

Player

Player class

Recjs

Kind: global class

$3

| 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
`js
const recjs = new Recjs({
el: '#someElement',
events: ['scroll'],
fps: 60
});
`


Recorder

Recorder class

Kind: global class

* Recorder
* .record()
* .isRecording() ⇒ boolean
* .stop()
* .pause()
* .getData(stringify) ⇒ object \| string

$3

Starts recording

Kind: instance method of Recorder
Example
`js
recjs.recorder.record()
`


$3

Check if it is recording

Kind: instance method of Recorder
Returns: boolean - True if it's recording
Example
`js
recjs.recorder.isRecording()
`


$3

Stops recording

Kind: instance method of Recorder
Example
`js
recjs.recorder.stop()
`


$3

Pauses current recording

Kind: instance method of Recorder
Example
`js
recjs.recorder.pause()
`


$3

Returns recorded data

Kind: instance method of Recorder

| Param | Type | Default |
| --- | --- | --- |
| stringify | boolean | false |

Example
`js
recjs.recorder.getData(true)
`


Player

Player class

Kind: global class

* Player
* .play(data, onEnd)
* .pause()
* .stop()
* .setFrameIndex(index)
* .currentFrame() ⇒ object
* .currentFrameIndex() ⇒ number
* .isPlaying() ⇒ boolean

$3

Starts playing a recording

Kind: instance method of Player

| Param | Type | Description |
| --- | --- | --- |
| data | object | Recorded data |
| onEnd | function | Calls when playing finishes |

Example
`js
recjs.player.play(recjs.recorder.getData(), () => {
console.log('Finished playing')
})
`


$3

Pauses playing

Kind: instance method of Player
Example
`js
recjs.player.pause()
`


$3

Stops playing

Kind: instance method of Player
Example
`js
recjs.player.stop()
`


$3

Set current frame

Kind: instance method of Player

| Param | Type | Description |
| --- | --- | --- |
| index | number | Frame index |

Example
`js
recjs.player.setFrameIndex(87)
`


$3

Get current frame

Kind: instance method of Player
Returns: object - Frame object
Example
`js
recjs.player.currentFrame()
`


$3

Get current frame index

Kind: instance method of Player
Returns: number - Frame index
Example
`js
recjs.player.currentFrameIndex()
`


$3

Is playing

Kind: instance method of Player
Returns: boolean - Returns true if it is playing
Example
`
recjs.player.isPlaying()
``