From f9a7c85539afa8c8aa598e25aee0aeb63867da81 Mon Sep 17 00:00:00 2001 From: Alexey Nesterov Date: Fri, 24 May 2024 08:19:43 +0100 Subject: [PATCH] Update README.md (#206) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Update README.md * fix: add note about frontend api --------- Co-authored-by: Ivar Conradi Østhus Co-authored-by: Fredrik Oseberg --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 2c19777..b8d1371 100644 --- a/README.md +++ b/README.md @@ -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