Skip to content

docs: document addSessionProperties method #248

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

Closed
wants to merge 1 commit into from
Closed

docs: document addSessionProperties method #248

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
18 changes: 18 additions & 0 deletions sdk/@launchdarkly/session-replay/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,24 @@ const client = init3(

```

## API Reference

### Adding Session Properties

Use `LDRecord.addSessionProperties()` to add custom session-level properties. These properties are attached to the current session and are searchable in LaunchDarkly, but unlike `track()` events, they do not create timeline Track events.

```typescript
import { LDRecord } from '@launchdarkly/session-replay'

LDRecord.addSessionProperties({
plan: 'pro',
userId: 'user-123',
organizationId: 'org-456'
})
```

Session properties are useful for attaching metadata to sessions that you want to search or filter by later, without cluttering the timeline with track events.

## Getting started

Refer to the [SDK documentation](https://docs.launchdarkly.com/sdk/client-side/javascript#getting-started) for instructions on getting started with using the SDK.
Expand Down
Loading