feat: add Connection#ready

cody-greene · Nov 3, 2023 · 8e3a061 · 8e3a061
1 parent f72117b
commit 8e3a061
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+# v4.4.0
+Features:
+- added a boolean getter, `connection.ready`: True if the connection is established and unblocked. Useful for healthchecks and the like.
+
 # v4.3.0
 Consumers now track some simple statistics: total messages acknowledged/requeued/dropped, and the current number of prefetched messages. Find these values in the `consumer.stats` object.
 

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "rabbitmq-client",
-  "version": "4.3.0",
+  "version": "4.4.0",
   "description": "Robust, typed, RabbitMQ (0-9-1) client library",
   "homepage": "https://github.com/cody-greene/node-rabbitmq-client",
   "repository": {

diff --git a/src/Connection.ts b/src/Connection.ts
@@ -659,6 +659,11 @@ export class Connection extends EventEmitter {
   queueUnbind(params: MethodParams[Cmd.QueueUnbind]): Promise<void> {
     return this._lazy().then(ch => ch.queueUnbind(params))
   }
+
+  /** True if the connection is established and unblocked. See also {@link Connection#on:BLOCKED | Connection#on('connection.blocked')}) */
+  get ready(): boolean {
+    return this._state.readyState === READY_STATE.OPEN && !this._socket.writableCorked
+  }
 }
 
 function determineHeartbeat(x: number, y: number): number {