@@ -34,7 +34,7 @@ export interface ISplitStatus {
34
34
isDestroyed : boolean ;
35
35
36
36
/**
37
- * `lastUpdate` indicates when the most recent status event was emitted . This timestamp is only updated for events that are being listened to,
37
+ * `lastUpdate` indicates the timestamp of the most recent status event. This timestamp is only updated for events that are being listened to,
38
38
* configured via the `updateOnSdkReady` option for `SDK_READY` event, `updateOnSdkReadyFromCache` for `SDK_READY_FROM_CACHE` event,
39
39
* `updateOnSdkTimedout` for `SDK_READY_TIMED_OUT` event, and `updateOnSdkUpdate` for `SDK_UPDATE` event.
40
40
*/
@@ -47,29 +47,25 @@ export interface ISplitStatus {
47
47
export interface IUpdateProps {
48
48
49
49
/**
50
- * `updateOnSdkUpdate` indicates if the hook or component will update (i.e., re-render) in case of an `SDK_UPDATE` event.
51
- * If `true`, hooks or components consuming the context (such as `useSplitClient` and `useSplitTreatments`) will re-render on `SDK_UPDATE`.
50
+ * `updateOnSdkUpdate` indicates if the hook or component will update (i.e., re-render) or not in case of an `SDK_UPDATE` event.
52
51
* It's value is `true` by default.
53
52
*/
54
53
updateOnSdkUpdate ?: boolean ;
55
54
56
55
/**
57
- * `updateOnSdkTimedout` indicates if the hook or component will update (i.e., re-render) in case of a `SDK_READY_TIMED_OUT` event.
58
- * If `true`, hooks or components consuming the context (such as `useSplitClient` and `useSplitTreatments`) will re-render on `SDK_READY_TIMED_OUT`.
56
+ * `updateOnSdkTimedout` indicates if the hook or component will update (i.e., re-render) or not in case of a `SDK_READY_TIMED_OUT` event.
59
57
* It's value is `true` by default.
60
58
*/
61
59
updateOnSdkTimedout ?: boolean ;
62
60
63
61
/**
64
- * `updateOnSdkReady` indicates if the hook or component will update (i.e., re-render) in case of a `SDK_READY` event.
65
- * If `true`, hooks or components consuming the context (such as `useSplitClient` and `useSplitTreatments`) will re-render on `SDK_READY`.
62
+ * `updateOnSdkReady` indicates if the hook or component will update (i.e., re-render) or not in case of a `SDK_READY` event.
66
63
* It's value is `true` by default.
67
64
*/
68
65
updateOnSdkReady ?: boolean ;
69
66
70
67
/**
71
- * `updateOnSdkReadyFromCache` indicates if the hook or component will update (i.e., re-render) in case of a `SDK_READY_FROM_CACHE` event.
72
- * If `true`, hooks or components consuming the context (such as `useSplitClient` and `useSplitTreatments`) will re-render on `SDK_READY_FROM_CACHE`.
68
+ * `updateOnSdkReadyFromCache` indicates if the hook or component will update (i.e., re-render) or not in case of a `SDK_READY_FROM_CACHE` event.
73
69
* This params is only relevant when using `'LOCALSTORAGE'` as storage type, since otherwise the event is never emitted.
74
70
* It's value is `true` by default.
75
71
*/
0 commit comments