Skip to content

Commit 46a3a0a

Browse files
committed
Add comment for users about empty string
1 parent 8b3fbc1 commit 46a3a0a

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

packages/app/src/heartbeatService.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,8 @@ export class HeartbeatServiceImpl implements HeartbeatService {
119119
* Returns a base64 encoded string which can be attached to the heartbeat-specific header directly.
120120
* It also clears all heartbeats from memory as well as in IndexedDB.
121121
*
122-
* NOTE: It will read heartbeats from the heartbeatsCache, instead of from indexedDB to reduce latency
122+
* NOTE: Consuming product SDKs should not send the header if this method
123+
* returns an empty string.
123124
*/
124125
async getHeartbeatsHeader(): Promise<string> {
125126
if (this._heartbeatsCache === null) {

0 commit comments

Comments
 (0)