polishing

Author: EmilianoSanchez

.github/workflows/ci.yml

@@ -77,7 +77,7 @@ jobs:
             -Dsonar.pullrequest.base=${{ github.event.pull_request.base.ref }}
 
       - name: Store assets
-        if: github.event_name == 'push' && (github.ref == 'refs/heads/master' || github.ref == 'refs/heads/flagSets_xor')
+        if: github.event_name == 'push' && (github.ref == 'refs/heads/master' || github.ref == 'refs/heads/development')
         uses: actions/upload-artifact@v3
         with:
           name: assets
@@ -88,7 +88,7 @@ jobs:
     name: Upload assets
     runs-on: ubuntu-latest
     needs: build
-    if: github.event_name == 'push' && github.ref == 'refs/heads/flagSets_xor'
+    if: github.event_name == 'push' && github.ref == 'refs/heads/development'
     strategy:
       matrix:
         environment:

src/__tests__/SplitTreatments.test.tsx

@@ -161,7 +161,7 @@ describe('SplitTreatments', () => {
       </SplitTreatments>
     );
 
-    expect(logSpy).toBeCalledWith('[WARN]  Both names and flagSets props were provided. flagSets will be ignored.');
+    expect(logSpy).toBeCalledWith('[WARN]  Both names and flagSets properties were provided. flagSets will be ignored.');
   });
 });
 

src/__tests__/useSplitTreatments.test.tsx

@@ -256,7 +256,7 @@ describe('useSplitTreatments', () => {
       })
     );
 
-    expect(logSpy).toHaveBeenLastCalledWith('[WARN]  Both names and flagSets props were provided. flagSets will be ignored.');
+    expect(logSpy).toHaveBeenLastCalledWith('[WARN]  Both names and flagSets properties were provided. flagSets will be ignored.');
   });
 
 });

src/constants.ts

@@ -40,4 +40,4 @@ export const WARN_ST_NO_CLIENT: string = '[WARN]  SplitTreatments does not have
 
 export const EXCEPTION_NO_REACT_OR_CREATECONTEXT: string = 'React library is not available or its version is not supported. Check that it is properly installed or imported. Split SDK requires version 16.3.0+ of React.';
 
-export const WARN_NAMES_AND_FLAGSETS: string = '[WARN]  Both names and flagSets props were provided. flagSets will be ignored.';
+export const WARN_NAMES_AND_FLAGSETS: string = '[WARN]  Both names and flagSets properties were provided. flagSets will be ignored.';

src/useClient.ts

@@ -5,7 +5,8 @@ import { useSplitClient } from './useSplitClient';
  * It uses the 'useContext' hook to access the context, which is updated by
  * SplitFactory and SplitClient components in the hierarchy of components.
  *
- * @return A Split Client instance, or null if used outside the scope of SplitFactory
+ * @returns A Split Client instance, or null if used outside the scope of SplitFactory
+ *
  * @see {@link https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK#advanced-instantiate-multiple-sdk-clients}
  *
  * @deprecated Replace with the new `useSplitClient` hook.

src/useManager.ts

@@ -5,7 +5,8 @@ import { useSplitManager } from './useSplitManager';
  * It uses the 'useContext' hook to access the factory at Split context, which is updated by
  * the SplitFactory component.
  *
- * @return A Split Manager instance, or null if used outside the scope of SplitFactory
+ * @returns A Split Manager instance, or null if used outside the scope of SplitFactory
+ *
  * @see {@link https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK#manager}
  *
  * @deprecated Replace with the new `useSplitManager` hook.

src/useSplitClient.ts

@@ -14,7 +14,7 @@ export const DEFAULT_UPDATE_OPTIONS = {
  * 'useSplitClient' is a hook that returns an Split Context object with the client and its status corresponding to the provided key and trafficType.
  * It uses the 'useContext' hook to access the context, which is updated by SplitFactory and SplitClient components in the hierarchy of components.
  *
- * @return A Split Context object
+ * @returns A Split Context object
  *
  * @example
  * ```js

src/useSplitManager.ts

@@ -6,7 +6,7 @@ import { ISplitContextValues } from './types';
  * 'useSplitManager' is a hook that returns an Split Context object with the Manager instance from the Split factory.
  * It uses the 'useContext' hook to access the factory at Split context, which is updated by the SplitFactory component.
  *
- * @return An object containing the Split context and the Split Manager instance, which is null if used outside the scope of SplitFactory
+ * @returns An object containing the Split context and the Split Manager instance, which is null if used outside the scope of SplitFactory
  *
  * @example
  * ```js

src/useSplitTreatments.ts

@@ -8,7 +8,7 @@ import { useSplitClient } from './useSplitClient';
  * It uses the 'useSplitClient' hook to access the client from the Split context, and invokes the 'client.getTreatmentsWithConfig()' method if the `names` option is provided,
  * or the 'client.getTreatmentsWithConfigByFlagSets()' method if the `flagSets` option is provided.
  *
- * @return A Split Context object extended with a TreatmentsWithConfig instance, that might contain control treatments if the client is not available or ready, or if feature flag names do not exist.
+ * @returns A Split Context object extended with a TreatmentsWithConfig instance, that might contain control treatments if the client is not available or ready, or if feature flag names do not exist.
  *
  * @example
  * ```js

src/useTrack.ts

@@ -7,7 +7,8 @@ const noOpFalse = () => false;
  * 'useTrack' is a hook that returns the track method from a Split client.
  * It uses the 'useContext' hook to access the client from the Split context.
  *
- * @return A track function bound to a Split client. If the client is not available, the result is a no-op function that returns false.
+ * @returns A track function bound to a Split client. If the client is not available, the result is a no-op function that returns false.
+ *
  * @see {@link https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK#track}
  */
 export function useTrack(splitKey?: SplitIO.SplitKey, trafficType?: string): SplitIO.IBrowserClient['track'] {