Fix the comment.

mqttjs · Jun 21, 2021 · 3907b67 · 3907b67
1 parent 7c1368f
commit 3907b67
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/lib/unique-message-id-provider.js b/lib/unique-message-id-provider.js
@@ -18,7 +18,8 @@ function UniqueMessageIdProvider () {
  * allocate
  *
  * Get the next messageId.
- * @return unsigned int
+ * @return if messageId is fully allocated then return null,
+ *         otherwise return the smallest usable unsigned int messageId.
  */
 UniqueMessageIdProvider.prototype.allocate = function () {
   this.lastId = this.numberAllocator.alloc()