Skip to content

Commit

Permalink
Update README.md (#206)
Browse files Browse the repository at this point in the history
* Update README.md

* fix: add note about frontend api

---------

Co-authored-by: Ivar Conradi Østhus <[email protected]>
Co-authored-by: Fredrik Oseberg <[email protected]>
  • Loading branch information
3 people authored May 24, 2024
1 parent 99c9848 commit f9a7c85
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,8 @@ The Unleash SDK takes the following options:
| customHeaders | no| `{}` | Additional headers to use when making HTTP requests to the Unleash proxy. In case of name collisions with the default headers, the `customHeaders` value will be used if it is not `null` or `undefined`. `customHeaders` values that are `null` or `undefined` will be ignored. |
| impressionDataAll | no| `false` | Allows you to trigger "impression" events for **all** `getToggle` and `getVariant` invocations. This is particularly useful for "disabled" feature toggles that are not visible to frontend SDKs. |
| environment | no | `default` | Sets the `environment` option of the [Unleash context](https://docs.getunleash.io/reference/unleash-context). This does **not** affect the SDK's [Unleash environment](https://docs.getunleash.io/reference/environments). |
| usePOSTrequests | no | `false` | Configures the client to use POST requests instead of GET when requesting enabled features. This is helpful when sensitive information (like user email, when used as a user ID) is passed in the context to avoid leaking it in the URL. NOTE: Post requests are not supported by the frontend api built into Unleash. |


### Listen for updates via the EventEmitter

Expand Down

0 comments on commit f9a7c85

Please sign in to comment.