Skip to content

Documentation for ClientOptions#sweepers is incorrect #9579

@ImRodry

Description

@ImRodry

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

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions