Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-11 17:13:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

refactor: improve typings and docs related to threads (#5991)

Browse Source 
Co-authored-by: SpaceEEC <spaceeec@yahoo.com>
This commit is contained in:
Shubham Parihar
2021-07-04 01:08:38 +05:30
committed by GitHub
parent 7e3001191c
commit 4bf49809f2
4 changed files with 94 additions and 76 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
typings/index.d.ts vendored
View File

@@ -1582,7 +1582,7 @@ declare module 'discord.js' {
public defaultAutoArchiveDuration?: ThreadAutoArchiveDuration;
public messages: MessageManager;
public nsfw: boolean;
public threads: ThreadManager;
public threads: ThreadManager<AllowedThreadTypeForNewsChannel>;
public topic: string | null;
public type: 'news';
public createWebhook(name: string, options?: ChannelWebhookCreateOptions): Promise<Webhook>;
@@ -1936,7 +1936,7 @@ declare module 'discord.js' {
public nsfw: boolean;
public type: 'text';
public rateLimitPerUser: number;
public threads: ThreadManager;
public threads: ThreadManager<AllowedThreadTypeForTextChannel>;
public topic: string | null;
public createWebhook(name: string, options?: ChannelWebhookCreateOptions): Promise<Webhook>;
public setDefaultAutoArchiveDuration(
@@ -2655,21 +2655,12 @@ declare module 'discord.js' {
public delete(channel: StageChannel | Snowflake): Promise<void>;
}
export class ThreadManager extends BaseManager<Snowflake, ThreadChannel, ThreadChannelResolvable> {
export class ThreadManager<AllowedThreadType> extends BaseManager<Snowflake, ThreadChannel, ThreadChannelResolvable> {
constructor(channel: TextChannel | NewsChannel, iterable?: Iterable<any>);
public channel: TextChannel | NewsChannel;
public create(options: {
name: string;
autoArchiveDuration: ThreadAutoArchiveDuration;
startMessage?: MessageResolvable;
type?: ThreadChannelType | number;
reason?: string;
}): Promise<ThreadChannel>;
public create(options: ThreadCreateOptions<AllowedThreadType>): Promise<ThreadChannel>;
public fetch(options: ThreadChannelResolvable, cacheOptions?: BaseFetchOptions): Promise<ThreadChannel | null>;
public fetch(
options?: { archived?: FetchArchivedThreadOptions; active?: boolean },
cacheOptions?: { cache?: boolean },
): Promise<FetchedThreads>;
public fetch(options?: FetchThreadsOptions, cacheOptions?: { cache?: boolean }): Promise<FetchedThreads>;
public fetchArchived(options?: FetchArchivedThreadOptions, cache?: boolean): Promise<FetchedThreads>;
public fetchActive(cache?: boolean): Promise<FetchedThreads>;
}
@@ -2790,6 +2781,10 @@ declare module 'discord.js' {
deaf?: boolean;
}
type AllowedThreadTypeForNewsChannel = 'news_thread' | 10;
type AllowedThreadTypeForTextChannel = 'public_thread' | 'private_thread' | 11 | 12;
interface APIErrors {
UNKNOWN_ACCOUNT: 10001;
UNKNOWN_APPLICATION: 10002;
@@ -3387,6 +3382,11 @@ declare module 'discord.js' {
after?: Snowflake;
}
interface FetchThreadsOptions {
archived?: FetchArchivedThreadOptions;
active?: boolean;
}
interface FileOptions {
attachment: BufferResolvable | Stream;
name?: string;
@@ -4349,6 +4349,14 @@ declare module 'discord.js' {
type ThreadChannelType = 'news_thread' | 'public_thread' | 'private_thread';
interface ThreadCreateOptions<AllowedThreadType> {
name: string;
autoArchiveDuration: ThreadAutoArchiveDuration;
startMessage?: MessageResolvable;
type?: AllowedThreadType;
reason?: string;
}
interface ThreadEditData {
name?: string;
archived?: boolean;