Skip to content

Document replay.stop({ flush: false }) option #18759

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
logaretm merged 1 commit into from
Jul 20, 2026
Merged

Document replay.stop({ flush: false }) option #18759

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/platforms/javascript/common/session-replay/understanding-sessions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,16 @@ await replay.stop();

This will flush any pending recording data, stop the replay, and end the session.

If you don't want the pending segment to be sent when stopping (for example, when a user withdraws consent for Session Replay), pass `{ flush: false }`:

<AvailableSince version="10.67.0" />

```javascript
await replay.stop({ flush: false });
```

This stops recording and discards the buffered segment instead of uploading it. Note that `flush: false` only prevents the _pending_ (final) segment from being sent. It does not retract segments that were already sent earlier during `session` recording.

## Manually Flushing Recording Data

You can flush any pending recording data with:
Expand Down
Loading