Update type definition comment for names and flagSets params

splitio · Nov 14, 2023 · 9ea53a0 · 9ea53a0
1 parent 902c38b
commit 9ea53a0
Showing 1 changed file with 4 additions and 4 deletions.
diff --git a/src/types.ts b/src/types.ts
@@ -177,12 +177,12 @@ export interface ISplitClientProps extends IUseSplitClientOptions {
 export interface IUseSplitTreatmentsOptions extends IUseSplitClientOptions {
 
   /**
-   * list of feature flag names
+   * list of feature flag names to evaluate. If provided, the `flagSets` option is ignored.
    */
   names?: string[];
 
   /**
-   * list of feature flag sets
+   * list of feature flag sets to evaluate.
    */
   flagSets?: string[];
 }
@@ -220,12 +220,12 @@ export interface ISplitTreatmentsProps {
   children: ((props: ISplitTreatmentsChildProps) => ReactNode);
 
   /**
-   * list of feature flag names
+   * list of feature flag names to evaluate. If provided, the `flagSets` prop is ignored.
    */
   names?: string[];
 
   /**
-   * list of feature flag sets
+   * list of feature flag sets to evaluate.
    */
   flagSets?: string[];
 }