ThreadChannel

A ThreadChannel is a thread, or a post of a forum. It is what channel.isThread() gives, and what message.startThread(), channel.startThread() and forum.createPost() return.

import type { ThreadChannel } from 'chapterjs';

async function close(thread: ThreadChannel, reason: string) {
  if (thread.archived) return;
  await thread.send(`Closing this thread: ${reason}`);
  await thread.edit({ archived: true, locked: true }, reason);
}

How to send, edit and read messages is in Sending messages.

Properties

It also has everything of Channel and what channels with messages share. A thread is not a GuildChannel: it has no overwrites of its own, and takes the permissions of the channel it is in.

Snowflake

The id of the server of the thread.

Guild

The server of the thread.

string

The name of the thread.

Snowflake

The id of the channel the thread was created in.

TextChannel | ForumChannel | null

The channel the thread was created in; null when it is of a kind this version does not know.

Snowflake | null

The id of the user who created the thread.

boolean

Whether the thread is archived.

boolean

Whether only moderators can unarchive it.

boolean

Whether only invited members and moderators can see it.

Date | null

When the thread was archived or unarchived for the last time.

number

An approximate count of the members of the thread (stops at 50).

readonly Snowflake[]

The ids of the tags of the post, in a forum.

Helpers

permissionsFor()

permissionsFor(member: GuildMember): Permissions

Threads inherit the permissions of the channel they are in.

Reading from Discord

fetchMembers()

fetchMembers(options?: { limit?: number; after?: Snowflake }): Promise<ThreadMember[]>

Who is in the thread (100 at most per call). Each entry is a ThreadMember. Discord documentation

Actions

edit()

edit(options: ThreadEditOptions, reason?: string): Promise<this>

Changes the thread: name, archive, lock, slowmode, tags. The options are a ThreadEditOptions. Discord documentation

archive()

archive(reason?: string): Promise<this>

Archives the thread: it leaves the channel list but can come back. Discord documentation

unarchive()

unarchive(reason?: string): Promise<this>

Brings an archived thread back. Discord documentation

join()

join(): Promise<void>

Makes the bot join the thread. Discord documentation

leave()

leave(): Promise<void>

Makes the bot leave the thread. Discord documentation

addMember()

addMember(user: Snowflake | { id: Snowflake }): Promise<void>

Adds a member to the thread. Discord documentation

removeMember()

removeMember(user: Snowflake | { id: Snowflake }): Promise<void>

Removes a member from the thread. Discord documentation

Reference

Your files

Structures

Types

CLI

Properties

Helpers

permissionsFor()

Reading from Discord

fetchMembers()

Actions

edit()

archive()

unarchive()

join()

leave()

addMember()

removeMember()