Class ThreadChannel<ThreadOnly>

Construct a type with the properties of T except for those in type K.

Type Parameters

ThreadOnly extends boolean = boolean

Hierarchy (View Summary)

Omit<
TextBasedChannelFields<true>,
"fetchWebhooks" | "createWebhook" | "setNSFW",
>
BaseChannel
- ThreadChannel
  - PublicThreadChannel
  - PrivateThreadChannel

Properties

appliedTags

appliedTags: string[]

archived

archived: null | boolean

archiveTimestamp

archiveTimestamp: null | number

autoArchiveDuration

autoArchiveDuration: null | ThreadAutoArchiveDuration

`Readonly`client

client: Client<true>

flags

flags: Readonly<ChannelFlagsBitField>

guild

guild: Guild

guildId

guildId: string

id

id: string

invitable

invitable: null | boolean

lastMessage

lastMessage: null | Message<boolean>

lastMessageId

lastMessageId: null | string

lastPinAt

lastPinAt: null | Date

lastPinTimestamp

lastPinTimestamp: null | number

locked

locked: null | boolean

memberCount

memberCount: null | number

members

members: ThreadMemberManager

messageCount

messageCount: null | number

messages

messages: GuildMessageManager

name

name: string

ownerId

ownerId: string

parentId

parentId: null | string

rateLimitPerUser

rateLimitPerUser: null | number

totalMessageSent

totalMessageSent: null | number

type

type: ThreadChannelType

Accessors

archivedAt

get archivedAt(): null | Date
Returns null | Date
- Defined in node_modules/discord.js/typings/index.d.ts:3695

createdAt

get createdAt(): null | Date
Returns null | Date
- Defined in node_modules/discord.js/typings/index.d.ts:3697

createdTimestamp

get createdTimestamp(): null | number
Returns null | number
- Defined in node_modules/discord.js/typings/index.d.ts:3699

editable

get editable(): boolean
Returns boolean
- Defined in node_modules/discord.js/typings/index.d.ts:3701

guildMembers

get guildMembers(): Collection<string, GuildMember>
Returns Collection<string, GuildMember>
- Defined in node_modules/discord.js/typings/index.d.ts:3705

joinable

get joinable(): boolean
Returns boolean
- Defined in node_modules/discord.js/typings/index.d.ts:3707

joined

get joined(): boolean
Returns boolean
- Defined in node_modules/discord.js/typings/index.d.ts:3708

manageable

get manageable(): boolean
Returns boolean
- Defined in node_modules/discord.js/typings/index.d.ts:3710

parent

get parent(): | null
| If<ThreadOnly, ForumChannel | MediaChannel, NewsChannel | TextChannel>
Returns null | If<ThreadOnly, ForumChannel | MediaChannel, NewsChannel | TextChannel>
- Defined in node_modules/discord.js/typings/index.d.ts:3720

partial

get partial(): false
Returns false
- Defined in node_modules/discord.js/typings/index.d.ts:1043

sendable

get sendable(): boolean
Returns boolean
- Defined in node_modules/discord.js/typings/index.d.ts:3712

unarchivable

get unarchivable(): boolean
Returns boolean
- Defined in node_modules/discord.js/typings/index.d.ts:3724

url

get url(): string
Returns string
- Defined in node_modules/discord.js/typings/index.d.ts:1045

viewable

get viewable(): boolean
Returns boolean
- Defined in node_modules/discord.js/typings/index.d.ts:3711

Methods

awaitMessageComponent

awaitMessageComponent<ComponentType extends MessageComponentType>(
options?: AwaitMessageCollectorOptionsParams<ComponentType, true>,
): Promise<MappedInteractionTypes<boolean>[ComponentType]>
Type Parameters
- ComponentType extends MessageComponentType
Parameters
- Optionaloptions: AwaitMessageCollectorOptionsParams<ComponentType, true>
Returns Promise<MappedInteractionTypes<boolean>[ComponentType]>
Inherited from Omit.awaitMessageComponent
- Defined in node_modules/discord.js/typings/index.d.ts:5234

awaitMessages

awaitMessages(
options?: AwaitMessagesOptions,
): Promise<Collection<string, Message<boolean>>>
Parameters
- Optionaloptions: AwaitMessagesOptions
Returns Promise<Collection<string, Message<boolean>>>
Inherited from Omit.awaitMessages
- Defined in node_modules/discord.js/typings/index.d.ts:5237

bulkDelete

bulkDelete(
    messages:
        | number
        | Collection<string, Message<boolean>>
        | readonly MessageResolvable[],
    filterOld?: boolean,
): Promise<
    Collection<string, undefined | Message<boolean> | PartialMessage>,
>
Parameters
- messages: number | Collection<string, Message<boolean>> | readonly MessageResolvable[]
- OptionalfilterOld: boolean
Returns Promise<Collection<string, undefined | Message<boolean> | PartialMessage>>
Inherited from Omit.bulkDelete
- Defined in node_modules/discord.js/typings/index.d.ts:5238

createMessageCollector

createMessageCollector(options?: MessageCollectorOptions): MessageCollector
Parameters
- Optionaloptions: MessageCollectorOptions
Returns MessageCollector
Inherited from Omit.createMessageCollector
- Defined in node_modules/discord.js/typings/index.d.ts:5245

createMessageComponentCollector

createMessageComponentCollector<ComponentType extends MessageComponentType>(
options?: MessageChannelCollectorOptionsParams<ComponentType, true>,
): InteractionCollector<MappedInteractionTypes<boolean>[ComponentType]>
Type Parameters
- ComponentType extends MessageComponentType
Parameters
- Optionaloptions: MessageChannelCollectorOptionsParams<ComponentType, true>
Returns InteractionCollector<MappedInteractionTypes<boolean>[ComponentType]>
Inherited from Omit.createMessageComponentCollector
- Defined in node_modules/discord.js/typings/index.d.ts:5242

delete

delete(reason?: string): Promise<ThreadChannel<ThreadOnly>>
Parameters
- Optionalreason: string
Returns Promise<ThreadChannel<ThreadOnly>>
Inherited from BaseChannel.delete
- Defined in node_modules/discord.js/typings/index.d.ts:3725

edit

edit(options: ThreadEditOptions): Promise<ThreadChannel<ThreadOnly>>
Parameters
- options: ThreadEditOptions
Returns Promise<ThreadChannel<ThreadOnly>>
- Defined in node_modules/discord.js/typings/index.d.ts:3726

fetch

fetch(force?: boolean): Promise<ThreadChannel<ThreadOnly>>
Parameters
- Optionalforce: boolean
Returns Promise<ThreadChannel<ThreadOnly>>
Inherited from BaseChannel.fetch
- Defined in node_modules/discord.js/typings/index.d.ts:1047

fetchOwner

fetchOwner(
options?: FetchThreadOwnerOptions,
): Promise<null | ThreadMember<boolean>>
Parameters
- Optionaloptions: FetchThreadOwnerOptions
Returns Promise<null | ThreadMember<boolean>>
- Defined in node_modules/discord.js/typings/index.d.ts:3734

fetchStarterMessage

fetchStarterMessage(options?: BaseFetchOptions): Promise<null | Message<true>>
Parameters
- Optionaloptions: BaseFetchOptions
Returns Promise<null | Message<true>>
- Defined in node_modules/discord.js/typings/index.d.ts:3735

isDMBased

isDMBased(): this is DMChannel | PartialDMChannel | PartialGroupDMChannel
Returns this is DMChannel | PartialDMChannel | PartialGroupDMChannel
Inherited from BaseChannel.isDMBased
- Defined in node_modules/discord.js/typings/index.d.ts:1050

isSendable

isSendable(): this is SendableChannels
Returns this is SendableChannels
Inherited from BaseChannel.isSendable
- Defined in node_modules/discord.js/typings/index.d.ts:1053

isTextBased

isTextBased(): this is TextBasedChannel
Returns this is TextBasedChannel
Inherited from BaseChannel.isTextBased
- Defined in node_modules/discord.js/typings/index.d.ts:1049

isThread

isThread(): this is AnyThreadChannel
Returns this is AnyThreadChannel
Inherited from BaseChannel.isThread
- Defined in node_modules/discord.js/typings/index.d.ts:1048

isThreadOnly

isThreadOnly(): this is ThreadOnlyChannel
Returns this is ThreadOnlyChannel
Inherited from BaseChannel.isThreadOnly
- Defined in node_modules/discord.js/typings/index.d.ts:1052

isVoiceBased

isVoiceBased(): this is VoiceBasedChannel
Returns this is VoiceBasedChannel
Inherited from BaseChannel.isVoiceBased
- Defined in node_modules/discord.js/typings/index.d.ts:1051

join

join(): Promise<ThreadChannel<ThreadOnly>>
Returns Promise<ThreadChannel<ThreadOnly>>
- Defined in node_modules/discord.js/typings/index.d.ts:3727

leave

leave(): Promise<ThreadChannel<ThreadOnly>>
Returns Promise<ThreadChannel<ThreadOnly>>
- Defined in node_modules/discord.js/typings/index.d.ts:3728

permissionsFor

permissionsFor(
memberOrRole: GuildMember | Role,
checkAdmin?: boolean,
): Readonly<PermissionsBitField>
Parameters
- memberOrRole: GuildMember | Role
- OptionalcheckAdmin: boolean
Returns Readonly<PermissionsBitField>
- Defined in node_modules/discord.js/typings/index.d.ts:3729
permissionsFor(
    memberOrRole:
        | string
        | User
        | GuildMember
        | Role
        | Message<boolean>
        | ThreadMember<boolean>,
    checkAdmin?: boolean,
): null | Readonly<PermissionsBitField>
Parameters
- memberOrRole: string | User | GuildMember | Role | Message<boolean> | ThreadMember<boolean>
- OptionalcheckAdmin: boolean
Returns null | Readonly<PermissionsBitField>
- Defined in node_modules/discord.js/typings/index.d.ts:3730

pin(reason?: string): Promise<If<ThreadOnly, ThreadChannel<ThreadOnly>, never>>
Parameters
- Optionalreason: string
Returns Promise<If<ThreadOnly, ThreadChannel<ThreadOnly>, never>>
- Defined in node_modules/discord.js/typings/index.d.ts:3743

send

send(
options: string | MessagePayload | MessageCreateOptions,
): Promise<Message<true>>
Parameters
- options: string | MessagePayload | MessageCreateOptions
Returns Promise<Message<true>>
Inherited from Omit.send
- Defined in node_modules/discord.js/typings/index.d.ts:5224

sendTyping

sendTyping(): Promise<void>
Returns Promise<void>
Inherited from Omit.sendTyping
- Defined in node_modules/discord.js/typings/index.d.ts:5248

setAppliedTags

setAppliedTags(
appliedTags: readonly string[],
reason?: string,
): Promise<If<ThreadOnly, ThreadChannel<ThreadOnly>, never>>
Parameters
- appliedTags: readonly string[]
- Optionalreason: string
Returns Promise<If<ThreadOnly, ThreadChannel<ThreadOnly>, never>>
- Defined in node_modules/discord.js/typings/index.d.ts:3742

setArchived

setArchived(
archived?: boolean,
reason?: string,
): Promise<ThreadChannel<ThreadOnly>>
Parameters
- Optionalarchived: boolean
- Optionalreason: string
Returns Promise<ThreadChannel<ThreadOnly>>
- Defined in node_modules/discord.js/typings/index.d.ts:3736

setAutoArchiveDuration

setAutoArchiveDuration(
autoArchiveDuration: ThreadAutoArchiveDuration,
reason?: string,
): Promise<ThreadChannel<ThreadOnly>>
Parameters
- autoArchiveDuration: ThreadAutoArchiveDuration
- Optionalreason: string
Returns Promise<ThreadChannel<ThreadOnly>>
- Defined in node_modules/discord.js/typings/index.d.ts:3737

setInvitable

setInvitable(
invitable?: boolean,
reason?: string,
): Promise<ThreadChannel<ThreadOnly>>
Parameters
- Optionalinvitable: boolean
- Optionalreason: string
Returns Promise<ThreadChannel<ThreadOnly>>
- Defined in node_modules/discord.js/typings/index.d.ts:3738

setLocked

setLocked(locked?: boolean, reason?: string): Promise<ThreadChannel<ThreadOnly>>
Parameters
- Optionallocked: boolean
- Optionalreason: string
Returns Promise<ThreadChannel<ThreadOnly>>
- Defined in node_modules/discord.js/typings/index.d.ts:3739

setName

setName(name: string, reason?: string): Promise<ThreadChannel<ThreadOnly>>
Parameters
- name: string
- Optionalreason: string
Returns Promise<ThreadChannel<ThreadOnly>>
- Defined in node_modules/discord.js/typings/index.d.ts:3740

setRateLimitPerUser

setRateLimitPerUser(
rateLimitPerUser: number,
reason?: string,
): Promise<TextBasedChannelFields<true, boolean>>
Parameters
- rateLimitPerUser: number
- Optionalreason: string
Returns Promise<TextBasedChannelFields<true, boolean>>
Inherited from Omit.setRateLimitPerUser
- Defined in node_modules/discord.js/typings/index.d.ts:5249

toJSON

toJSON(...props: Record<string, string | boolean>[]): unknown
Parameters
- ...props: Record<string, string | boolean>[]
Returns unknown
Inherited from BaseChannel.toJSON
- Defined in node_modules/discord.js/typings/index.d.ts:560

toString

toString(): `<#${string}>`
Returns a string representation of an object.

Returns `<#${string}>`
Inherited from BaseChannel.toString
- Defined in node_modules/discord.js/typings/index.d.ts:3745

unpin

unpin(
reason?: string,
): Promise<If<ThreadOnly, ThreadChannel<ThreadOnly>, never>>
Parameters
- Optionalreason: string
Returns Promise<If<ThreadOnly, ThreadChannel<ThreadOnly>, never>>
- Defined in node_modules/discord.js/typings/index.d.ts:3744

valueOf

valueOf(): string
Returns string
Inherited from BaseChannel.valueOf
- Defined in node_modules/discord.js/typings/index.d.ts:561

Class ThreadChannel<ThreadOnly>

Type Parameters

Hierarchy (View Summary)

Index

Properties

Accessors

Methods

Properties

appliedTags

archived

archiveTimestamp

autoArchiveDuration

Readonlyclient

flags

guild

guildId

id

invitable

lastMessage

lastMessageId

lastPinAt

lastPinTimestamp

locked

memberCount

members

messageCount

messages

name

ownerId

parentId

rateLimitPerUser

totalMessageSent

type

Accessors

archivedAt

Returns null | Date

createdAt

Returns null | Date

createdTimestamp

Returns null | number

editable

Returns boolean

guildMembers

Returns Collection<string, GuildMember>

joinable

Returns boolean

joined

Returns boolean

manageable

Returns boolean

parent

Returns null | If<ThreadOnly, ForumChannel | MediaChannel, NewsChannel | TextChannel>

partial

Returns false

sendable

Returns boolean

unarchivable

Returns boolean

url

Returns string

viewable

Returns boolean

Methods

awaitMessageComponent

Type Parameters

Parameters

Returns Promise<MappedInteractionTypes<boolean>[ComponentType]>

awaitMessages

Parameters

Returns Promise<Collection<string, Message<boolean>>>

bulkDelete

Parameters

Returns Promise<Collection<string, undefined | Message<boolean> | PartialMessage>>

createMessageCollector

Parameters

Returns MessageCollector

createMessageComponentCollector

Type Parameters

Parameters

Returns InteractionCollector<MappedInteractionTypes<boolean>[ComponentType]>

`Readonly`client