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.

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

Documentation for ClientOptions#sweepers is incorrect #9579

Closed
ImRodry opened this issue May 17, 2023 · 2 comments · Fixed by #9591
Closed

Documentation for ClientOptions#sweepers is incorrect #9579

ImRodry opened this issue May 17, 2023 · 2 comments · Fixed by #9591

Comments

@ImRodry
Copy link
Contributor

ImRodry commented May 17, 2023

Which package is this bug report for?

discord.js

Issue description

The documentation for ClientOptions#sweepers mentions that the default value for this option is an empty object, which is not true. The default can be found below

/**
* The default settings passed to {@link ClientOptions.sweepers}.
* The sweepers that this changes are:
* * `threads` - Sweep archived threads every hour, removing those archived more than 4 hours ago
* <info>If you want to keep default behavior and add on top of it you can use this object and add on to it, e.g.
* `sweepers: { ...Options.DefaultSweeperSettings, messages: { interval: 300, lifetime: 600 } }`</info>
* @type {SweeperOptions}
*/
static get DefaultSweeperSettings() {
return {
threads: {
interval: 3600,
lifetime: 14400,
},
};
}
}

Code sample

No response

Versions

Djs v14.10.0

Issue priority

Low (slightly annoying)

Which partials do you have configured?

Not applicable

Which gateway intents are you subscribing to?

Not applicable

I have tested this issue on a development release

No response

@ryoh827
Copy link
Contributor

ryoh827 commented May 20, 2023

I'd like to try this issue.

@ImRodry
Copy link
Contributor Author

ImRodry commented May 21, 2023

@Jiralite good first issue? Lol

@kodiakhq kodiakhq bot closed this as completed in #9591 Jun 9, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 8, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants