Preview environment

interface GuildTextThreadCreateOptions

export interface GuildTextThreadCreateOptions<AllowedThreadType> extends StartThreadOptions

Options for creating a thread. Only one of startMessage or type can be defined.

Type Parameters

AllowedThreadType

optional
autoArchiveDuration? : ThreadAutoArchiveDuration

The amount of time after which the thread should automatically archive in case of no recent activity

Inherited from: StartThreadOptions

optional
invitable? : AllowedThreadType extends ChannelType.PrivateThread ? boolean : never

Whether non-moderators can add other non-moderators to the thread Can only be set when type will be ChannelType.PrivateThread

name : string

The name of the new thread

Inherited from: StartThreadOptions

optional
rateLimitPerUser? : number

The rate limit per user (slowmode) for the thread in seconds

Inherited from: StartThreadOptions

optional
reason? : string

Reason for creating the thread

Inherited from: StartThreadOptions

optional
startMessage? : MessageResolvable

The message to start a thread from. If this is defined, then the type of thread gets inferred automatically and cannot be changed.

optional
type? : AllowedThreadType

The type of thread to create. Defaults to ChannelType.PublicThread if created in a TextChannel When creating threads in a NewsChannel, this is ignored and is always ChannelType.AnnouncementThread