2.1.0 • Published 2 weeks ago

@rrweb/record

Licence

MIT

Version

2.1.0

Deps

Size

2.1 MB

Vulns

Weekly

Stars

19.9K

Summary Dependency Versions

This package contains all the record related code in rrweb and is designed to be published in a frontend app/webpage. See Getting Started in the rrweb guide for more information including the record options.

For websocket based recording against the rrweb cloud API use the browser-client which builds on this package and accepts the same record options.

Installation

1) Bundler / npm (Recommended)

npm install @rrweb/record

import { record } from '@rrweb/record';

2) Browser Without Bundler (ESM)

Use the CDN-hosted @rrweb/record browser asset when loading directly in the browser:

<script type="module">
  import { record } from 'https://cdn.rrweb.com/record/current/dist/record.js';
</script>

Use current for the latest stable release, or pin an exact version such as https://cdn.rrweb.com/record/2.0.0/dist/record.js for immutable production URLs.

3) Legacy Direct `<script>` Include (UMD fallback)

Use this only for compatibility with non-module environments.

<script src="https://cdn.rrweb.com/record/current/dist/record.umd.cjs"></script>

The legacy UMD global is rrwebRecord.

Usage

import { record } from '@rrweb/record';

record({
  emit(event) {
    // send event to server
  },
});

Notes

Currently this package is really just a wrapper around the record function in the main rrweb package. All record related code will get moved here in the future.