Skip to content

Commit ea96d5a

Browse files
committed
Revert changes to original docs
1 parent 7f44cbb commit ea96d5a

File tree

3 files changed

+4
-6
lines changed

3 files changed

+4
-6
lines changed

src/initLDClient.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,7 @@ 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 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.
13+
* @param targetFlags If specified, `launchdarkly-react-client-sdk` will only request and listen to these flags.
1514
* Flag keys must be in their original form as known to LaunchDarkly rather than in their camel-cased form.
1615
*
1716
* @see `ProviderConfig` for more details about the parameters

src/types.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,8 @@ export interface ProviderConfig {
6767
reactOptions?: LDReactOptions;
6868

6969
/**
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.
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.
7272
* Flag keys must be in their original form as known to LaunchDarkly rather than in their camel-cased form.
7373
*/
7474
flags?: LDFlagSet;

src/utils.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,7 @@ export const getFlattenedFlagsFromChangeset = (
5353
*
5454
* @param ldClient LaunchDarkly client
5555
* @param reactOptions Initialization options for the LaunchDarkly React SDK
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.
56+
* @param targetFlags If specified, `launchdarkly-react-client-sdk` will only request and listen to these flags.
5857
* Flag keys must be in their original form as known to LaunchDarkly rather than in their camel-cased form.
5958
*
6059
* @returns an `LDFlagSet` with the current flag values from LaunchDarkly filtered by `targetFlags`.

0 commit comments

Comments
 (0)