Skip to content

Commit 97fa28a

Browse files
authored
Fix inaccurate comments about how targetFlags work (#106)
The following is not correct: ``` * If specified, `launchdarkly-react-client-sdk` will only request and listen to these flags. ``` It should instead say: ``` * If specified, `launchdarkly-react-client-sdk` will only listen for changes to these flags. ```
1 parent 3940c66 commit 97fa28a

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

src/initLDClient.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ const wrapperOptions: LDOptions = {
1515
* @param clientSideID Your project and environment specific client side ID
1616
* @param context A LaunchDarkly context object
1717
* @param options LaunchDarkly initialization options
18-
* @param targetFlags If specified, `launchdarkly-react-client-sdk` will only request and listen to these flags.
18+
* @param targetFlags If specified, `launchdarkly-react-client-sdk` will only listen for changes to these flags.
1919
* Flag keys must be in their original form as known to LaunchDarkly rather than in their camel-cased form.
2020
*
2121
* @see `ProviderConfig` for more details about the parameters

src/types.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ export interface ProviderConfig {
7878
reactOptions?: LDReactOptions;
7979

8080
/**
81-
* If specified, `launchdarkly-react-client-sdk` will only request and listen to these flags.
81+
* If specified, `launchdarkly-react-client-sdk` will only listen for changes to these flags.
8282
* Otherwise, all flags will be requested and listened to.
8383
* Flag keys must be in their original form as known to LaunchDarkly rather than in their camel-cased form.
8484
*/

src/utils.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ export const getFlattenedFlagsFromChangeset = (
5454
* Retrieves flag values.
5555
*
5656
* @param ldClient LaunchDarkly client
57-
* @param targetFlags If specified, `launchdarkly-react-client-sdk` will only request and listen to these flags.
57+
* @param targetFlags If specified, `launchdarkly-react-client-sdk` will only listen for changes to these flags.
5858
* Flag keys must be in their original form as known to LaunchDarkly rather than in their camel-cased form.
5959
*
6060
* @returns an `LDFlagSet` with the current flag values from LaunchDarkly filtered by `targetFlags`.

0 commit comments

Comments
 (0)