Skip to content

Commit

Permalink
docs: Add apply note to readme (#125)
Browse files Browse the repository at this point in the history
Add apply note to readme
  • Loading branch information
fabriziodemaria authored Mar 14, 2024
1 parent fae882f commit 2bc0bae
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ Notes:
## Apply events
This Provider automatically emits `apply` events to the Confidence backend once a flag's property is read by the application. This allows Confidence to track who was exposed to what variant and when.

_Note: the `apply` event is only generated for flags that are successfully evaluated (i.e. default values returned due to errors don't generate `apply` events)._
_Note: the `apply` event reports which flag and variant was read by the application, but not which property the application has read from such variant's value._

To avoid generating redundant data, as long as the flags' data returned from the backend for a user remains unchanged, only the first time a flag's property is read will generate an `apply` event. This is true also across restarts of the application.
Expand Down

0 comments on commit 2bc0bae

Please sign in to comment.