{"id":20497147,"url":"https://github.com/alexcambose/recjs","last_synced_at":"2025-08-09T15:04:02.882Z","repository":{"id":57096355,"uuid":"116997535","full_name":"alexcambose/recjs","owner":"alexcambose","description":"Lightweight user session recorder based on JSON","archived":false,"fork":false,"pushed_at":"2018-01-24T19:08:05.000Z","size":180,"stargazers_count":13,"open_issues_count":0,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-03T09:45:38.956Z","etag":null,"topics":["dom","json","movies","recording","screen","session","spy","user"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/alexcambose.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-01-10T18:51:08.000Z","updated_at":"2023-12-25T17:38:49.000Z","dependencies_parsed_at":"2022-08-22T21:40:28.653Z","dependency_job_id":null,"html_url":"https://github.com/alexcambose/recjs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexcambose%2Frecjs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexcambose%2Frecjs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexcambose%2Frecjs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexcambose%2Frecjs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alexcambose","download_url":"https://codeload.github.com/alexcambose/recjs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248759132,"owners_count":21157094,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dom","json","movies","recording","screen","session","spy","user"],"created_at":"2024-11-15T18:10:12.072Z","updated_at":"2025-04-13T18:21:53.076Z","avatar_url":"https://github.com/alexcambose.png","language":"JavaScript","readme":"# recjs\n\n[![JavaScript Style Guide](https://cdn.rawgit.com/standard/standard/master/badge.svg)](https://github.com/standard/standard)\n[![Build Status](https://travis-ci.org/alexcambose/recjs.svg?branch=master)](https://travis-ci.org/alexcambose/recjs)\n\nLightweight user session recorder based on JSON\n\n## Installation\nIn browser:\n\n```html\n\u003cscript src=\"dist/dist.js\"\u003e\u003c/script\u003e\n```\n\nIn Node.js\n\n```bash\nnpm install --save @alexcambose/recjs\n```\n\n```javascript\nimport Recjs from 'recjs';\n```\n\n## Usage\n\n```html\n...\n\u003cbody\u003e\n    \u003cdiv id=\"someElement\"\u003e\u003c/div\u003e\n\u003c/body\u003e\n...\n```\n\n### Example 1\n\n```javascript\nconst recjs = new Recjs();\nrecjs.recorder.record(); // starts recording\n\nsetTimeout(() =\u003e {\n    recjs.recorder.stop(); // stops recording after 3 seconds\n    console.log(recjs.recorder.getData()) // gets recording data\n}, 3000);\n```\n\n### Example 2\n\n```javascript\nconst recjs = new Recjs();\nrecjs.recorder.record(); // starts recording\n\nsetTimeout(() =\u003e {\n    recjs.recorder.stop(); // stops recording after 3 seconds\n    recjs.player.play(recjs.recorder.getData(), () =\u003e console.log('Finished')); // plays current recording and logs when finishes\n}, 3000);\n```\n\n## API Reference\n\n## Classes\n\n\u003cdl\u003e\n\u003cdt\u003e\u003ca href=\"#Recjs\"\u003eRecjs\u003c/a\u003e\u003c/dt\u003e\n\u003cdd\u003e\u003c/dd\u003e\n\u003cdt\u003e\u003ca href=\"#Recorder\"\u003eRecorder\u003c/a\u003e\u003c/dt\u003e\n\u003cdd\u003e\u003cp\u003eRecorder class\u003c/p\u003e\n\u003c/dd\u003e\n\u003cdt\u003e\u003ca href=\"#Player\"\u003ePlayer\u003c/a\u003e\u003c/dt\u003e\n\u003cdd\u003e\u003cp\u003ePlayer class\u003c/p\u003e\n\u003c/dd\u003e\n\u003c/dl\u003e\n\n\u003ca name=\"Recjs\"\u003e\u003c/a\u003e\n\n## Recjs\n**Kind**: global class\n\u003ca name=\"new_Recjs_new\"\u003e\u003c/a\u003e\n\n### new Recjs($0)\n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| $0 | \u003ccode\u003eObject\u003c/code\u003e |  |  |\n| [$0.events] | \u003ccode\u003earray\u003c/code\u003e | \u003ccode\u003e[\u0026#x27;scroll\u0026#x27;, \u0026#x27;mousemove\u0026#x27;, \u0026#x27;keypress\u0026#x27;, \u0026#x27;click\u0026#x27;, \u0026#x27;contextmenu\u0026#x27;]\u003c/code\u003e | User events that will be recorded |\n| [$0.fps] | \u003ccode\u003einteger\u003c/code\u003e | \u003ccode\u003e30\u003c/code\u003e | Number of frames per second |\n| [$0.document] | \u003ccode\u003eobject\u003c/code\u003e | \u003ccode\u003ewindow.document\u003c/code\u003e | Document object to be used. (in case of an iframe) |\n\n**Example**\n```js\nconst recjs = new Recjs({\n    events: ['scroll'],\n    fps: 60\n});\n```\n\u003ca name=\"Recorder\"\u003e\u003c/a\u003e\n\n## Recorder\nRecorder class\n\n**Kind**: global class\n\n* [Recorder](#Recorder)\n    * [.record()](#Recorder+record)\n    * [.isRecording()](#Recorder+isRecording) ⇒ \u003ccode\u003eboolean\u003c/code\u003e\n    * [.stop()](#Recorder+stop)\n    * [.pause()](#Recorder+pause)\n    * [.getData(stringify)](#Recorder+getData) ⇒ \u003ccode\u003eobject\u003c/code\u003e \\| \u003ccode\u003estring\u003c/code\u003e\n\n\u003ca name=\"Recorder+record\"\u003e\u003c/a\u003e\n\n### recorder.record()\nStarts recording\n\n**Kind**: instance method of [\u003ccode\u003eRecorder\u003c/code\u003e](#Recorder)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| [$0.onRecording] | \u003ccode\u003efunction\u003c/code\u003e | Calls each recorded frame |\n\n**Example**\n```js\nrecjs.recorder.record({\n   onRecording: () =\u003e console.log('Next frame')\n})\n```\n\u003ca name=\"Recorder+isRecording\"\u003e\u003c/a\u003e\n\n### recorder.isRecording() ⇒ \u003ccode\u003eboolean\u003c/code\u003e\nCheck if it is recording\n\n**Kind**: instance method of [\u003ccode\u003eRecorder\u003c/code\u003e](#Recorder)\n**Returns**: \u003ccode\u003eboolean\u003c/code\u003e - True if it's recording\n**Example**\n```js\nrecjs.recorder.isRecording()\n```\n\u003ca name=\"Recorder+stop\"\u003e\u003c/a\u003e\n\n### recorder.stop()\nStops recording\n\n**Kind**: instance method of [\u003ccode\u003eRecorder\u003c/code\u003e](#Recorder)\n**Example**\n```js\nrecjs.recorder.stop()\n```\n\u003ca name=\"Recorder+pause\"\u003e\u003c/a\u003e\n\n### recorder.pause()\nPauses current recording\n\n**Kind**: instance method of [\u003ccode\u003eRecorder\u003c/code\u003e](#Recorder)\n**Example**\n```js\nrecjs.recorder.pause()\n```\n\u003ca name=\"Recorder+getData\"\u003e\u003c/a\u003e\n\n### recorder.getData(stringify) ⇒ \u003ccode\u003eobject\u003c/code\u003e \\| \u003ccode\u003estring\u003c/code\u003e\nReturns recorded data\n\n**Kind**: instance method of [\u003ccode\u003eRecorder\u003c/code\u003e](#Recorder)\n\n| Param | Type | Default |\n| --- | --- | --- |\n| stringify | \u003ccode\u003eboolean\u003c/code\u003e | \u003ccode\u003efalse\u003c/code\u003e |\n\n**Example**\n```js\nrecjs.recorder.getData(true)\n```\n\u003ca name=\"Player\"\u003e\u003c/a\u003e\n\n## Player\nPlayer class\n\n**Kind**: global class\n\n* [Player](#Player)\n    * [.play(data)](#Player+play)\n    * [.pause()](#Player+pause)\n    * [.stop()](#Player+stop)\n    * [.setFrameIndex(index)](#Player+setFrameIndex)\n    * [.currentFrame()](#Player+currentFrame) ⇒ \u003ccode\u003eobject\u003c/code\u003e\n    * [.currentFrameIndex()](#Player+currentFrameIndex) ⇒ \u003ccode\u003enumber\u003c/code\u003e\n    * [.isPlaying()](#Player+isPlaying) ⇒ \u003ccode\u003eboolean\u003c/code\u003e\n\n\u003ca name=\"Player+play\"\u003e\u003c/a\u003e\n\n### player.play(data)\nStarts playing a recording\n\n**Kind**: instance method of [\u003ccode\u003ePlayer\u003c/code\u003e](#Player)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| data | \u003ccode\u003eobject\u003c/code\u003e | Recorded data |\n| [$0.onPlaying] | \u003ccode\u003efunction\u003c/code\u003e | Calls when playing finishes |\n| [$0.onEnd] | \u003ccode\u003efunction\u003c/code\u003e | Calls each frame |\n\n**Example**\n```js\nrecjs.player.play(recjs.recorder.getData(), {\n   onEnd: () =\u003e console.log('Finished playing'),\n   onPlaying: () =\u003e console.log('Next frame')\n})\n```\n\u003ca name=\"Player+pause\"\u003e\u003c/a\u003e\n\n### player.pause()\nPauses playing\n\n**Kind**: instance method of [\u003ccode\u003ePlayer\u003c/code\u003e](#Player)\n**Example**\n```js\nrecjs.player.pause()\n```\n\u003ca name=\"Player+stop\"\u003e\u003c/a\u003e\n\n### player.stop()\nStops playing\n\n**Kind**: instance method of [\u003ccode\u003ePlayer\u003c/code\u003e](#Player)\n**Example**\n```js\nrecjs.player.stop()\n```\n\u003ca name=\"Player+setFrameIndex\"\u003e\u003c/a\u003e\n\n### player.setFrameIndex(index)\nSet current frame\n\n**Kind**: instance method of [\u003ccode\u003ePlayer\u003c/code\u003e](#Player)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| index | \u003ccode\u003enumber\u003c/code\u003e | Frame index |\n\n**Example**\n```js\nrecjs.player.setFrameIndex(87)\n```\n\u003ca name=\"Player+currentFrame\"\u003e\u003c/a\u003e\n\n### player.currentFrame() ⇒ \u003ccode\u003eobject\u003c/code\u003e\nGet current frame\n\n**Kind**: instance method of [\u003ccode\u003ePlayer\u003c/code\u003e](#Player)\n**Returns**: \u003ccode\u003eobject\u003c/code\u003e - Frame object\n**Example**\n```js\nrecjs.player.currentFrame()\n```\n\u003ca name=\"Player+currentFrameIndex\"\u003e\u003c/a\u003e\n\n### player.currentFrameIndex() ⇒ \u003ccode\u003enumber\u003c/code\u003e\nGet current frame index\n\n**Kind**: instance method of [\u003ccode\u003ePlayer\u003c/code\u003e](#Player)\n**Returns**: \u003ccode\u003enumber\u003c/code\u003e - Frame index\n**Example**\n```js\nrecjs.player.currentFrameIndex()\n```\n\u003ca name=\"Player+isPlaying\"\u003e\u003c/a\u003e\n\n### player.isPlaying() ⇒ \u003ccode\u003eboolean\u003c/code\u003e\nIs playing\n\n**Kind**: instance method of [\u003ccode\u003ePlayer\u003c/code\u003e](#Player)\n**Returns**: \u003ccode\u003eboolean\u003c/code\u003e - Returns true if it is playing\n**Example**\n```js\nrecjs.player.isPlaying()\n```","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falexcambose%2Frecjs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falexcambose%2Frecjs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falexcambose%2Frecjs/lists"}