InvergeDocs
JavaScriptAPI reference

Session replay

Session replay in the JavaScript SDK.

// access
nexus.replay

NexusReplay

class

Browser session replay. Records the DOM with rrweb and ships the events to /partner/replay, correlated to the journey session — rendered natively by the Nexus console's player. Requires the optional rrweb peer dependency. No-op on the server.

Redaction: every input is masked by default ({@link NexusConfig.replayMaskAllInputs }); add the nexus-block class to fully block an element, or nexus-mask to mask its text (configurable via replayBlockClass / replayMaskTextClass).

NexusReplay

constructor
new NexusReplay(http: NexusHttp, id: NexusIdentity, cfg: ResolvedConfig)

Parameters

Prop

Type

Returns NexusReplay

View source

isRecording

property
readonly isRecording: boolean

start()

method
async start(): Promise<void>

Start recording (idempotent). No-op outside the browser or without rrweb.

View source

flush()

method
async flush(): Promise<void>

Ship any buffered events now.

View source

stop()

method
async stop(): Promise<void>

Stop recording and flush the remaining events.

View source

dispose()

method
dispose(): void
View source

On this page