feat(StartThreadOptions): default autoArchiveDuration to channel's defaultAutoArchiveDuration (#6278)

This commit is contained in:
Rodry
2021-10-27 11:07:28 +01:00
committed by GitHub
parent 88060395d1
commit 740d3f006e
3 changed files with 22 additions and 15 deletions

View File

@@ -59,17 +59,6 @@ class ThreadManager extends CachedManager {
* @returns {?Snowflake}
*/
/**
* A number that is allowed to be the duration (in minutes) of inactivity after which a thread is automatically
* archived. This can be:
* * `60` (1 hour)
* * `1440` (1 day)
* * `4320` (3 days) <warn>This is only available when the guild has the `THREE_DAY_THREAD_ARCHIVE` feature.</warn>
* * `10080` (7 days) <warn>This is only available when the guild has the `SEVEN_DAY_THREAD_ARCHIVE` feature.</warn>
* * `'MAX'` Based on the guild's features
* @typedef {number|string} ThreadAutoArchiveDuration
*/
/**
* Options for creating a thread. <warn>Only one of `startMessage` or `type` can be defined.</warn>
* @typedef {StartThreadOptions} ThreadCreateOptions
@@ -108,7 +97,14 @@ class ThreadManager extends CachedManager {
* .then(threadChannel => console.log(threadChannel))
* .catch(console.error);
*/
async create({ name, autoArchiveDuration, startMessage, type, invitable, reason } = {}) {
async create({
name,
autoArchiveDuration = this.channel.defaultAutoArchiveDuration,
startMessage,
type,
invitable,
reason,
} = {}) {
let path = this.client.api.channels(this.channel.id);
if (type && typeof type !== 'string' && typeof type !== 'number') {
throw new TypeError('INVALID_TYPE', 'type', 'ThreadChannelType or Number');

View File

@@ -779,12 +779,23 @@ class Message extends Base {
return this.channel.send(data);
}
/**
* A number that is allowed to be the duration (in minutes) of inactivity after which a thread is automatically
* archived. This can be:
* * `60` (1 hour)
* * `1440` (1 day)
* * `4320` (3 days) <warn>This is only available when the guild has the `THREE_DAY_THREAD_ARCHIVE` feature.</warn>
* * `10080` (7 days) <warn>This is only available when the guild has the `SEVEN_DAY_THREAD_ARCHIVE` feature.</warn>
* * `'MAX'` Based on the guild's features
* @typedef {number|string} ThreadAutoArchiveDuration
*/
/**
* Options for starting a thread on a message.
* @typedef {Object} StartThreadOptions
* @property {string} name The name of the new thread
* @property {ThreadAutoArchiveDuration} autoArchiveDuration The amount of time (in minutes) after which the thread
* should automatically archive in case of no recent activity
* @property {ThreadAutoArchiveDuration} [autoArchiveDuration=this.channel.defaultAutoArchiveDuration] The amount of
* time (in minutes) after which the thread should automatically archive in case of no recent activity
* @property {string} [reason] Reason for creating the thread
*/

2
typings/index.d.ts vendored
View File

@@ -4898,7 +4898,7 @@ export type StageInstanceResolvable = StageInstance | Snowflake;
export interface StartThreadOptions {
name: string;
autoArchiveDuration: ThreadAutoArchiveDuration;
autoArchiveDuration?: ThreadAutoArchiveDuration;
reason?: string;
}