Skip to content

Commit

Permalink
docs: clarify importance of withContext in server usage (#197)
Browse files Browse the repository at this point in the history
  • Loading branch information
andreas-karlsson authored Aug 29, 2024
1 parent 99c9659 commit 57aad0a
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions packages/sdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,9 @@ const childInstance = confidence.withContext({ 'pants-color': 'blue', 'pants-fit

At this point, the context of `childInstance` is `'pants-color': 'blue', 'pants-fit': 'slim'` while the context of `confidence` remains `{'pants-color': 'yellow'}`.

[!IMPORTANT]
When using the SDK in a server environment, you should call `withContext` rather than `setContext`. This will give you a new instance scoped to the request and prevent context from leaking between requests.

## Event tracking

Use `confidence.track()` from any Confidence instance to track an event in Confidence. Any context data set on the instance will be appended to the tracking event.
Expand Down

0 comments on commit 57aad0a

Please sign in to comment.