types: Use ThreadAutoArchiveDuration from discord-api-types (#8145)

This commit is contained in:
Jiralite
2022-06-22 10:23:39 +01:00
committed by GitHub
parent a061233510
commit a3799f9ebb
4 changed files with 9 additions and 15 deletions

View File

@@ -793,22 +793,12 @@ 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)
* * `10080` (7 days)
* @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=this.channel.defaultAutoArchiveDuration] The amount of
* time (in minutes) after which the thread should automatically archive in case of no recent activity
* time after which the thread should automatically archive in case of no recent activity
* @property {string} [reason] Reason for creating the thread
* @property {number} [rateLimitPerUser] The rate limit per user (slowmode) for the thread in seconds
*/

View File

@@ -292,7 +292,7 @@ class ThreadChannel extends Channel {
* @typedef {Object} ThreadEditData
* @property {string} [name] The new name for the thread
* @property {boolean} [archived] Whether the thread is archived
* @property {ThreadAutoArchiveDuration} [autoArchiveDuration] The amount of time (in minutes) after which the thread
* @property {ThreadAutoArchiveDuration} [autoArchiveDuration] The amount of time after which the thread
* should automatically archive in case of no recent activity
* @property {number} [rateLimitPerUser] The rate limit per user (slowmode) for the thread in seconds
* @property {boolean} [locked] Whether the thread is locked
@@ -344,7 +344,7 @@ class ThreadChannel extends Channel {
/**
* Sets the duration after which the thread will automatically archive in case of no recent activity.
* @param {ThreadAutoArchiveDuration} autoArchiveDuration The amount of time (in minutes) after which the thread
* @param {ThreadAutoArchiveDuration} autoArchiveDuration The amount of time after which the thread
* should automatically archive in case of no recent activity
* @param {string} [reason] Reason for changing the auto archive duration
* @returns {Promise<ThreadChannel>}

View File

@@ -338,6 +338,11 @@
* @see {@link https://discord-api-types.dev/api/discord-api-types-v10/enum/TextInputStyle}
*/
/**
* @external ThreadAutoArchiveDuration
* @see {@link https://discord-api-types.dev/api/discord-api-types-v10/enum/ThreadAutoArchiveDuration}
*/
/**
* @external UserFlags
* @see {@link https://discord-api-types.dev/api/discord-api-types-v10/enum/UserFlags}

View File

@@ -120,6 +120,7 @@ import {
MessageActivityType,
APIAttachment,
APIChannel,
ThreadAutoArchiveDuration,
} from 'discord-api-types/v10';
import { ChildProcess } from 'node:child_process';
import { EventEmitter } from 'node:events';
@@ -5409,8 +5410,6 @@ export type TextChannelResolvable = Snowflake | TextChannel;
export type TextBasedChannelResolvable = Snowflake | TextBasedChannel;
export type ThreadAutoArchiveDuration = 60 | 1440 | 4320 | 10080;
export type ThreadChannelResolvable = AnyThreadChannel | Snowflake;
export type ThreadChannelType =