Skip to content

Commit b3fdf38

Browse files
author
Emmanuel Zamora
committed
Update comments
1 parent e4af332 commit b3fdf38

4 files changed

Lines changed: 5 additions & 5 deletions

File tree

types/constants.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ export declare const ON: SplitIO.Treatment;
33
export declare const OFF: SplitIO.Treatment;
44
export declare const CONTROL: SplitIO.Treatment;
55
export declare const CONTROL_WITH_CONFIG: SplitIO.TreatmentWithConfig;
6-
export declare const getControlTreatmentsWithConfig: (splitNames: unknown) => SplitIO.TreatmentsWithConfig;
6+
export declare const getControlTreatmentsWithConfig: (featureFlagNames: unknown) => SplitIO.TreatmentsWithConfig;
77
export declare const WARN_SF_CONFIG_AND_FACTORY: string;
88
export declare const ERROR_SF_NO_CONFIG_AND_FACTORY: string;
99
export declare const ERROR_SC_NO_FACTORY: string;

types/types.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ export interface ISplitFactoryProps extends IUpdateProps {
9797
*/
9898
factory?: SplitIO.IBrowserSDK;
9999
/**
100-
* An object of type Attributes used to evaluate the splits.
100+
* An object of type Attributes used to evaluate the feature flags.
101101
*/
102102
attributes?: SplitIO.Attributes;
103103
/**
@@ -153,7 +153,7 @@ export interface ISplitTreatmentsChildProps extends ISplitContextValues {
153153
*/
154154
export interface ISplitTreatmentsProps {
155155
/**
156-
* list of Split names
156+
* list of feature flag names
157157
*/
158158
names: string[];
159159
/**

types/useTreatments.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,5 @@
66
* @return A TreatmentsWithConfig instance, that might contain control treatments if the client is not available or ready, or if split names do not exist.
77
* @see {@link https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK#get-treatments-with-configurations}
88
*/
9-
declare const useTreatments: (splitNames: string[], attributes?: import("@splitsoftware/splitio/types/splitio").Attributes | undefined, key?: import("@splitsoftware/splitio/types/splitio").SplitKey | undefined) => SplitIO.TreatmentsWithConfig;
9+
declare const useTreatments: (featureFlagNames: string[], attributes?: import("@splitsoftware/splitio/types/splitio").Attributes | undefined, key?: import("@splitsoftware/splitio/types/splitio").SplitKey | undefined) => SplitIO.TreatmentsWithConfig;
1010
export default useTreatments;

types/withSplitTreatments.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import { ISplitTreatmentsChildProps } from './types';
55
* The wrapped component receives all the props of the container,
66
* along with the passed props from SplitTreatments (see ISplitTreatmentsChildProps).
77
*
8-
* @param names list of Split names
8+
* @param names list of feature flag names
99
* @param attributes An object of type Attributes used to evaluate the splits.
1010
*/
1111
declare function withSplitTreatments(names: string[], attributes?: SplitIO.Attributes): <OuterProps>(WrappedComponent: React.ComponentType<OuterProps & ISplitTreatmentsChildProps>) => (props: OuterProps) => JSX.Element;

0 commit comments

Comments
 (0)