Merge pull request #1427 from tulios/delete-topics-timeout-docs

Document default topic deletion timeout
tulios · Jul 26, 2022 · 599198b · 599198b
2 parents ff6be44 + 3310227
commit 599198b
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 3 deletions.
diff --git a/docs/Admin.md b/docs/Admin.md
@@ -65,7 +65,7 @@ await admin.createTopics({
 ```javascript
 await admin.deleteTopics({
     topics: <String[]>,
-    timeout: <Number>,
+    timeout: <Number>, // default: 5000
 })
 ```
 

diff --git a/src/broker/index.js b/src/broker/index.js
@@ -584,8 +584,7 @@ module.exports = class Broker {
    * @param {object} request
    * @param {string[]} request.topics An array of topics to be deleted
    * @param {number} [request.timeout=5000] The time in ms to wait for a topic to be completely deleted on the
-   *                                controller node. Values <= 0 will trigger topic deletion and return
-   *                                immediately
+   *                                controller node.
    * @returns {Promise}
    */
   async deleteTopics({ topics, timeout = 5000 }) {