Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions packages/browser-sdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,8 @@ generate a `check` event, contrary to the `isEnabled` property on the object ret

### Remote config (beta)

Remote config is a dynamic and flexible approach to configuring feature behavior outside of your app – without needing to re-deploy it.

Similar to `isEnabled`, each feature has a `config` property. This configuration is managed from within Bucket.
It is managed similar to the way access to features is managed, but instead of the binary `isEnabled` you can have
multiple configuration values which are given to different user/companies.
Expand All @@ -194,10 +196,7 @@ const features = bucketClient.getFeatures();
// }
```

The `key` is always present while the `payload` is a optional JSON value for arbitrary configuration needs.
If feature has no configuration or, no configuration value was matched against the context, the `config` object
will be empty, thus, `key` will be `undefined`. Make sure to check against this case when trying to use the
configuration in your application.
`key` is mandatory for a config, but if a feature has no config or no config value was matched against the context, the `key` will be `undefined`. Make sure to check against this case when trying to use the configuration in your application. `payload` is an optional JSON value for arbitrary configuration needs.

Just as `isEnabled`, accessing `config` on the object returned by `getFeatures` does not automatically
generate a `check` event, contrary to the `config` property on the object returned by `getFeature`.
Expand Down
9 changes: 4 additions & 5 deletions packages/node-sdk/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Bucket Node.js SDK

Node.js, JavaScriptS/Typescript client for [Bucket.co](https://bucket.co).
Node.js, JavaScript/TypeScript client for [Bucket.co](https://bucket.co).

Bucket supports feature toggling, tracking feature usage, collecting feedback on features, and [remotely configuring features](#remote-config-beta).

Expand Down Expand Up @@ -228,6 +228,8 @@ const client = new BucketClient({

### Remote config (beta)

Remote config is a dynamic and flexible approach to configuring feature behavior outside of your app – without needing to re-deploy it.

Similar to `isEnabled`, each feature has a `config` property. This configuration is managed from within Bucket.
It is managed similar to the way access to features is managed, but instead of the binary `isEnabled` you can have
multiple configuration values which are given to different user/companies.
Expand All @@ -246,10 +248,7 @@ const features = bucketClient.getFeatures();
// }
```

The `key` is always present while the `payload` is a optional JSON value for arbitrary configuration needs.
If feature has no configuration or, no configuration value was matched against the context, the `config` object
will be empty, thus, `key` will be `undefined`. Make sure to check against this case when trying to use the
configuration in your application.
`key` is mandatory for a config, but if a feature has no config or no config value was matched against the context, the `key` will be `undefined`. Make sure to check against this case when trying to use the configuration in your application. `payload` is an optional JSON value for arbitrary configuration needs.

Just as `isEnabled`, accessing `config` on the object returned by `getFeatures` does not automatically
generate a `check` event, contrary to the `config` property on the object returned by `getFeature`.
Expand Down
7 changes: 2 additions & 5 deletions packages/react-sdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ generates a `check` event.

## Remote config (beta)

In addition to toggling features on/off, Bucket supports remote configuration of features through Remote config.
Remote config is a dynamic and flexible approach to configuring feature behavior outside of your app – without needing to re-deploy it.

Similar to `isEnabled`, each feature accessed using the `useFeature()` hook, has a `config` property. This configuration is managed from within Bucket. It is managed similar to the way access to features is managed, but instead of the
binary `isEnabled` you can have multiple configuration values which are given to different user/companies.
Expand Down Expand Up @@ -149,10 +149,7 @@ const {
// payload: { maxTokens: 10000, model: "gpt-3.5-beta1" }
```

The `key` is always present while the `payload` is a optional JSON value for arbitrary configuration needs.
If a feature has no configuration or no configuration value was matched against the context, the config object will be empty.
Thus, `key` will be `undefined`. Make sure to check against this case when trying to use the
configuration in your application.
`key` is mandatory for a config, but if a feature has no config or no config value was matched against the context, the `key` will be `undefined`. Make sure to check against this case when trying to use the configuration in your application. `payload` is an optional JSON value for arbitrary configuration needs.

Note that, similar to `isEnabled`, accessing `config` on the object returned by `useFeature()` automatically
generates a `check` event.
Expand Down