File tree Expand file tree Collapse file tree 3 files changed +9
-4
lines changed
Expand file tree Collapse file tree 3 files changed +9
-4
lines changed Original file line number Diff line number Diff line change @@ -10,7 +10,9 @@ import * as packageInfo from '../package.json';
1010 * @param user A LaunchDarkly user object
1111 * @param reactOptions Initialization options for the LaunchDarkly React SDK
1212 * @param options LaunchDarkly initialization options
13- * @param targetFlags If specified, `launchdarkly-react-client-sdk` will only request and listen to these flags.
13+ * @param targetFlags Set of flags that the SDK should pay attention to, as a map of keys to default values.
14+ * Only these flags will appear in the flags object, and only changes to these flags will trigger a rerender.
15+ * Flag keys must be in their original form as known to LaunchDarkly rather than in their camel-cased form.
1416 *
1517 * @see `ProviderConfig` for more details about the parameters
1618 * @return An initialized client and flags
Original file line number Diff line number Diff line change @@ -67,8 +67,9 @@ export interface ProviderConfig {
6767 reactOptions ?: LDReactOptions ;
6868
6969 /**
70- * If specified, `launchdarkly-react-client-sdk` will only request and listen to these flags.
71- * Otherwise, all flags will be requested and listened to.
70+ * Set of flags that the SDK should pay attention to, as a map of keys to default values.
71+ * Only these flags will appear in the flags object, and only changes to these flags will trigger a rerender.
72+ * Flag keys must be in their original form as known to LaunchDarkly rather than in their camel-cased form.
7273 */
7374 flags ?: LDFlagSet ;
7475
Original file line number Diff line number Diff line change @@ -53,7 +53,9 @@ export const getFlattenedFlagsFromChangeset = (
5353 *
5454 * @param ldClient LaunchDarkly client
5555 * @param reactOptions Initialization options for the LaunchDarkly React SDK
56- * @param targetFlags If specified, `launchdarkly-react-client-sdk` will only request and listen to these flags.
56+ * @param targetFlags Set of flags that the SDK should pay attention to, as a map of keys to default values.
57+ * Only these flags will appear in the flags object, and only changes to these flags will trigger a rerender.
58+ * Flag keys must be in their original form as known to LaunchDarkly rather than in their camel-cased form.
5759 *
5860 * @returns an `LDFlagSet` with the current flag values from LaunchDarkly filtered by `targetFlags`.
5961 */
You can’t perform that action at this time.
0 commit comments