docs: document addSessionProperties method #248
Closed
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds user-facing documentation for the
addSessionPropertiesmethod that was implemented in PR #247. The method allows developers to add custom session-level properties that are searchable in LaunchDarkly without creating timeline track events.Key additions:
LDRecord.addSessionProperties()How did you test this change?
yarn format:all@launchdarkly/session-replaypackageAre there any deployment considerations?
No deployment considerations - this is documentation only and will be published with the next package release.
Link to Devin run: https://app.devin.ai/sessions/c37a8e09a1eb45498053821a57f0e051
Requested by: @ccschmitz-launchdarkly
Review Checklist
Please verify:
Note
Adds an API Reference section documenting LDRecord.addSessionProperties with a usage example and explanation of searchable session properties without creating track events.
LDRecord.addSessionProperties()with TypeScript example.Written by Cursor Bugbot for commit 85e329c. This will update automatically on new commits. Configure here.