Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document default topic deletion timeout #1427

Merged
merged 1 commit into from
Jul 26, 2022
Merged

Document default topic deletion timeout #1427

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/Admin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ await admin.createTopics({
```javascript
await admin.deleteTopics({
topics: <String[]>,
timeout: <Number>,
timeout: <Number>, // default: 5000
})
```

Expand Down
3 changes: 1 addition & 2 deletions src/broker/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 }) {
Expand Down