🔍 Description

Expose latency for heartbeats when we get a reply. Only available for status ok and error otherwise undefined. It's backwards compatible because the second argument is number | undefined so a callback with just one argument will stil work fine.

I've also changed so that it matches the heartbeatRef when the message arrives. This avoids any potential race condition where the message for a previous heartbeat arrives later but we had already given up on that previous heartbeat.

What changed?

An extra latency can be passed to the heartbeat callback when heartbeat gets a reply from the server. RealtimeClient keeps track of the last time the heartbeat was sent and provide the diff.

Why was this change needed?

A feature that can help people react to high latency users like people on slow mobile internet.

📸 Screenshots/Examples

🔄 Breaking changes

• This PR contains no breaking changes

📋 Checklist

• I have read the Contributing Guidelines
• My PR title follows the conventional commit format: <type>(<scope>): <description>
• I have run npx nx format to ensure consistent code formatting
• I have added tests for new functionality (if applicable)
• I have updated documentation (if applicable)

📝 Additional notes