Polishing

Author: EmilianoSanchez

.github/workflows/sonar-scan.yml

@@ -19,7 +19,7 @@ jobs:
         with:
           fetch-depth: 0
 
-      - name: Set up nodejs
+      - name: Set up Node.js
         uses: actions/setup-node@v3
         with:
           node-version: 'lts/*'

MIGRATION-GUIDE.md

@@ -17,10 +17,7 @@ For example, you should replace:
 ```ts
 import { SplitFactory } from '@splitsoftware/splitio-browserjs';
 
-const config: SplitIO.IBrowserSettings = {
-  ...
-}
-
+const config: SplitIO.IBrowserSettings = { ... };
 const factory: SplitIO.ISDK = SplitFactory(config);
 ```
 
@@ -29,10 +26,7 @@ with:
 ```ts
 import { SplitFactory } from '@splitsoftware/splitio-browserjs';
 
-const config: SplitIO.IClientSideSettings = {
-  ...
-}
-
+const config: SplitIO.IClientSideSettings = { ... };
 const factory: SplitIO.IBrowserSDK = SplitFactory(config);
 ```
 
@@ -80,11 +74,12 @@ const factory = SplitFactory({
 
 The Google Analytics integrations were removed since they integrate with the *Google Universal Analytics* library, which was shut down on July 1, 2024, and [replaced by *Google Analytics 4*](https://support.google.com/analytics/answer/11583528?hl=en). Check [this docs](https://help.split.io/hc/en-us/articles/360040838752-Google-Analytics#google-analytics-4-ga4) for more information on how to integrate Split with Google Analytics 4.
 
-## Removed internal ponyfills for the `Map` and `Set` global objects, dropping support for IE and other outdated browsers. The SDK now requires the runtime environment to support these features natively or provide a polyfill
+## Removed internal polyfills for the `Map` and `Set` global objects, dropping support for IE and other outdated browsers
+
+The SDK no longer ships with internal implementations for the `Map` and `Set` global objects, which were used to support old browsers like IE.
 
-The SDK no longer ships with internal implementations for the `Map` and `Set` global objects, which were used to support old browsers.
 If you need to target environments that do not support these features natively, you should provide a polyfill for them. For example, [es6-map](https://github.com/medikoo/es6-map) for `Map`, and [es6-set](https://github.com/medikoo/es6-set) for `Set`.
 
 ## Dropped support for Split Proxy below version 5.9.0. The SDK now requires Split Proxy 5.9.0 or above
 
-If using the Split Proxy with the SDK in the browser, make sure to update it to version 5.9.0 or above. This is required due to the introduction of Large Segments matchers in the SDK on client-side, which uses a new HTTP endpoint to retrieve the segments data and is only supported by Split Proxy 5.9.0.
+If using the Split Proxy with the SDK, make sure to update it to version 5.9.0 or above. This is required due to the introduction of Large Segments matchers in the SDK on client-side, which uses a new HTTP endpoint to retrieve the segments data and is only supported by Split Proxy 5.9.0.

README.md

@@ -70,7 +70,7 @@ Split has built and maintains SDKs for:
 * Java [Github](https://github.com/splitio/java-client) [Docs](https://help.split.io/hc/en-us/articles/360020405151-Java-SDK)
 * JavaScript [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK)
 * JavaScript for Browser [Github](https://github.com/splitio/javascript-browser-client) [Docs](https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK)
-* Node [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020564931-Node-js-SDK)
+* Node.js [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020564931-Node-js-SDK)
 * PHP [Github](https://github.com/splitio/php-client) [Docs](https://help.split.io/hc/en-us/articles/360020350372-PHP-SDK)
 * PHP thin-client [Github](https://github.com/splitio/php-thin-client) [Docs](https://help.split.io/hc/en-us/articles/18305128673933-PHP-Thin-Client-SDK)
 * Python [Github](https://github.com/splitio/python-client) [Docs](https://help.split.io/hc/en-us/articles/360020359652-Python-SDK)

ts-tests/index.ts

@@ -156,13 +156,13 @@ splitKey = 'someKey';
 
 /**** Tests for ISDK interface ****/
 
-// // For node with sync storage
+// // For Node.js with sync storage
 // nodeSettings = {
 //   core: {
 //     authorizationKey: 'key'
 //   }
 // };
-// // For node with async storage
+// // For Node.js with async storage
 // asyncSettings = {
 //   core: {
 //     authorizationKey: 'key'
@@ -217,9 +217,7 @@ SDK.settings.features = { 'split_x': 'on' };
 // Client and Manager
 client = SDK.client();
 client = SDK.client('a customer key');
-// client = SDK.client('a customer key', 'a traffic type'); // Not valid in Browser JS SDK
 manager = SDK.manager();
-// // Today async clients are only possible on Node. Shared client creation not available here.
 asyncClient = AsyncSDK.client();
 asyncManager = AsyncSDK.manager();
 
@@ -249,7 +247,7 @@ splitEvent = client.Event.SDK_READY_FROM_CACHE;
 splitEvent = client.Event.SDK_READY_TIMED_OUT;
 splitEvent = client.Event.SDK_UPDATE;
 
-// Client implements methods from IEventEmitter that is a subset of NodeJS.Events. Testing a few.
+// Client implements methods from IEventEmitter that is a subset of Node.js EventEmitter. Testing a few.
 client = client.on(splitEvent, () => { });
 const a: boolean = client.emit(splitEvent);
 client = client.removeAllListeners(splitEvent);
@@ -341,7 +339,7 @@ splitEvent = asyncClient.Event.SDK_READY_FROM_CACHE;
 splitEvent = asyncClient.Event.SDK_READY_TIMED_OUT;
 splitEvent = asyncClient.Event.SDK_UPDATE;
 
-// Client implements methods from NodeJS.Events. (same as for sync client, just for interface checking)
+// Client implements methods from Node.js EventEmitter. (same as for sync client, just for interface checking)
 asyncClient = asyncClient.on(splitEvent, () => { });
 const a1: boolean = asyncClient.emit(splitEvent);
 asyncClient = asyncClient.removeAllListeners(splitEvent);
@@ -428,7 +426,7 @@ splitViews = manager.splits();
 // Manager implements ready promise.
 promise = manager.ready();
 
-// Manager implements methods from NodeJS.Events. Testing a few.
+// Manager implements methods from Node.js EventEmitter. Testing a few.
 manager = manager.on(splitEvent, () => { });
 const aa: boolean = manager.emit(splitEvent);
 manager = manager.removeAllListeners(splitEvent);
@@ -451,7 +449,7 @@ splitViewsAsync = asyncManager.splits();
 // asyncManager implements ready promise.
 promise = asyncManager.ready();
 
-// asyncManager implements methods from NodeJS.Events. Testing a few.
+// asyncManager implements methods from Node.js EventEmitter. Testing a few.
 asyncManager = asyncManager.on(splitEvent, () => { });
 const aaa: boolean = asyncManager.emit(splitEvent);
 asyncManager = asyncManager.removeAllListeners(splitEvent);