Skip to content

Commit 02447ea

Browse files
Keep __getStatus to avoid breaking change
1 parent 6092b0c commit 02447ea

File tree

2 files changed

+16
-12
lines changed

2 files changed

+16
-12
lines changed

CHANGES.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
2.8.0 (October XX, 2025)
1+
2.8.0 (October 28, 2025)
2+
- Added `client.getStatus()` method to retrieve the client readiness status properties (`isReady`, `isReadyFromCache`, etc).
23
- Added `client.whenReady()` and `client.whenReadyFromCache()` methods to replace the deprecated `client.ready()` method, which has an issue causing the returned promise to hang when using async/await syntax if it was rejected.
34
- Updated the SDK_READY_FROM_CACHE event to be emitted alongside the SDK_READY event if it hasn’t already been emitted.
45

src/readiness/sdkReadinessManager.ts

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,17 @@ export function sdkReadinessManagerFactory(
7272
return promise;
7373
}
7474

75+
function getStatus() {
76+
return {
77+
isReady: readinessManager.isReady(),
78+
isReadyFromCache: readinessManager.isReadyFromCache(),
79+
isTimedout: readinessManager.isTimedout(),
80+
hasTimedout: readinessManager.hasTimedout(),
81+
isDestroyed: readinessManager.isDestroyed(),
82+
isOperational: readinessManager.isOperational(),
83+
lastUpdate: readinessManager.lastUpdate(),
84+
};
85+
}
7586

7687
return {
7788
readinessManager,
@@ -134,17 +145,9 @@ export function sdkReadinessManagerFactory(
134145
});
135146
},
136147

137-
getStatus() {
138-
return {
139-
isReady: readinessManager.isReady(),
140-
isReadyFromCache: readinessManager.isReadyFromCache(),
141-
isTimedout: readinessManager.isTimedout(),
142-
hasTimedout: readinessManager.hasTimedout(),
143-
isDestroyed: readinessManager.isDestroyed(),
144-
isOperational: readinessManager.isOperational(),
145-
lastUpdate: readinessManager.lastUpdate(),
146-
};
147-
},
148+
getStatus,
149+
// @TODO: remove in next major
150+
__getStatus: getStatus
148151
}
149152
)
150153
};

0 commit comments

Comments
 (0)