# recjs
[](https://github.com/standard/standard)
[](https://travis-ci.org/alexcambose/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
...
...
```
### Example 1
```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);
```
### Example 2
```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
### new Recjs($0)
| 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](#Recorder)
* [.record()](#Recorder+record)
* [.isRecording()](#Recorder+isRecording) ⇒ boolean
* [.stop()](#Recorder+stop)
* [.pause()](#Recorder+pause)
* [.getData(stringify)](#Recorder+getData) ⇒ object \| string
### recorder.record()
Starts recording
**Kind**: instance method of [Recorder](#Recorder)
**Example**
```js
recjs.recorder.record()
```
### recorder.isRecording() ⇒ boolean
Check if it is recording
**Kind**: instance method of [Recorder](#Recorder)
**Returns**: boolean - True if it's recording
**Example**
```js
recjs.recorder.isRecording()
```
### recorder.stop()
Stops recording
**Kind**: instance method of [Recorder](#Recorder)
**Example**
```js
recjs.recorder.stop()
```
### recorder.pause()
Pauses current recording
**Kind**: instance method of [Recorder](#Recorder)
**Example**
```js
recjs.recorder.pause()
```
### recorder.getData(stringify) ⇒ object \| string
Returns recorded data
**Kind**: instance method of [Recorder](#Recorder)
| Param | Type | Default |
| --- | --- | --- |
| stringify | boolean | false |
**Example**
```js
recjs.recorder.getData(true)
```
## Player
Player class
**Kind**: global class
* [Player](#Player)
* [.play(data, onEnd)](#Player+play)
* [.pause()](#Player+pause)
* [.stop()](#Player+stop)
* [.setFrameIndex(index)](#Player+setFrameIndex)
* [.currentFrame()](#Player+currentFrame) ⇒ object
* [.currentFrameIndex()](#Player+currentFrameIndex) ⇒ number
* [.isPlaying()](#Player+isPlaying) ⇒ boolean
### player.play(data, onEnd)
Starts playing a recording
**Kind**: instance method of [Player](#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')
})
```
### player.pause()
Pauses playing
**Kind**: instance method of [Player](#Player)
**Example**
```js
recjs.player.pause()
```
### player.stop()
Stops playing
**Kind**: instance method of [Player](#Player)
**Example**
```js
recjs.player.stop()
```
### player.setFrameIndex(index)
Set current frame
**Kind**: instance method of [Player](#Player)
| Param | Type | Description |
| --- | --- | --- |
| index | number | Frame index |
**Example**
```js
recjs.player.setFrameIndex(87)
```
### player.currentFrame() ⇒ object
Get current frame
**Kind**: instance method of [Player](#Player)
**Returns**: object - Frame object
**Example**
```js
recjs.player.currentFrame()
```
### player.currentFrameIndex() ⇒ number
Get current frame index
**Kind**: instance method of [Player](#Player)
**Returns**: number - Frame index
**Example**
```js
recjs.player.currentFrameIndex()
```
### player.isPlaying() ⇒ boolean
Is playing
**Kind**: instance method of [Player](#Player)
**Returns**: boolean - Returns true if it is playing
**Example**
```
recjs.player.isPlaying()
```