Update type definition comments

Author: EmilianoSanchez

CHANGES.txt

@@ -1,4 +1,4 @@
-1.14.0 (September 12, 2024)
+1.14.0 (September 13, 2024)
  - Added `status` property to Split reducer's slice of state to track the SDK events of non-default clients (Related to https://github.com/splitio/redux-client/issues/113).
  - Added `lastUpdate` and `isTimedout` properties to the object returned by the `getStatus` helper and `selectTreatmentAndStatus` and `selectTreatmentWithConfigAndStatus` selectors, to expose the last event timestamp and the timedout status of the SDK clients (Related to https://github.com/splitio/redux-client/issues/113).
  - Added `selectStatus` selector to retrieve the status properties of the SDK manager and clients from the Split state.

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-redux",
-  "version": "1.14.0",
+  "version": "1.13.1-rc.2",
   "description": "A library to easily use Split JS SDK with Redux and React Redux",
   "main": "lib/index.js",
   "module": "es/index.js",

package.json

@@ -87,12 +87,10 @@ export function getSplits(): SplitIO.SplitViews {
 }
 
 /**
- * Gets an object with the status properties of the SDK client or manager:
+ * Gets an object with the status properties of the SDK client or manager.
  *
- * - `isReady` indicates if the SDK client has emitted the SDK_READY event.
- * - `isReadyFromCache` indicates if the SDK client has emitted the SDK_READY_FROM_CACHE event.
- * - `hasTimedout` indicates if the SDK client has emitted the SDK_READY_TIMED_OUT event.
- * - `isDestroyed` indicates if the SDK client has been destroyed, i.e., if the `destroySplitSdk` action was dispatched.
+ * This function is similar to the `selectStatus` selector, but it does not require the Split state as a parameter since it uses the global `splitSdk` object.
+ * Consider using the `selectStatus` selector instead for a more Redux-friendly approach.
  *
  * @param {SplitIO.SplitKey} key To use only on client-side. Ignored in server-side. If a key is provided and a client associated to that key has been used, the status of that client is returned.
  * If no key is provided, the status of the main client and manager is returned (the main client shares the status with the manager).

src/helpers.ts

@@ -85,11 +85,15 @@ export function selectTreatmentWithConfigAndStatus(splitState: ISplitState, feat
 }
 
 /**
- * This function extracts the status properties of the client for the given user key from the Split state.
- * If no user key is provided, it returns the status properties of the main client, which matches the SDK manager status.
+ * Extracts an object with the status properties of the SDK manager or client from the Split state, for the given user key.
  *
  * @param {ISplitState} splitState
- * @param {SplitIO.SplitKey} key
+ * @param {SplitIO.SplitKey} key To use only on client-side. Ignored in server-side. If a key is provided and a client associated to that key has been used, the status of that client is returned.
+ * If no key is provided, the status of the main client and manager is returned (the main client shares the status with the manager).
+ *
+ * @returns {IStatus} The status of the SDK client or manager.
+ *
+ * @see {@link https://help.split.io/hc/en-us/articles/360038851551-Redux-SDK#subscribe-to-events}
  */
 export function selectStatus(splitState: ISplitState, key?: SplitIO.SplitKey): IStatus {
   const status = splitState ?