Class Invite<T, CH>

channel

• get channel(): null | (CH extends AnyInviteChannel
      ? CH
      : PartialInviteChannel)

• The channel this invite leads to. If the channel is not cached, this will be a partial with only id, name, and type`.

  Returns null | (CH extends AnyInviteChannel
      ? CH
      : PartialInviteChannel)

constructor

• new Invite<T, CH>(data, client): Invite<T, CH>

• Type Parameters

  • T extends InviteInfoTypes = "withMetadata"

  • CH extends AnyInviteChannel | Uncached = AnyInviteChannel | Uncached

  Parameters

  • data: RawInvite | RawInviteWithMetadata

  • client: Client<ClientEvents>

  Returns Invite<T, CH>

deleteInvite

• deleteInvite(reason?): Promise<Invite<"withMetadata", CH>>

• Delete this invite.

  Parameters

  • Optional reason: string

    The reason for deleting this invite.

  Returns Promise<Invite<"withMetadata", CH>>

inCachedChannel

• inCachedChannel(): this is Invite<T, AnyInviteChannel>

• Whether this invite belongs to a cached channel. The only difference on using this method over a simple if statement is to easily update all the invite properties typing definitions based on the channel it belongs to.

  Returns this is Invite<T, AnyInviteChannel>

toJSON

• toJSON(): JSONInvite

• Returns JSONInvite

Optional approximateMemberCount

Optional approximatePresenceCount

channelID

client

code

createdAt

Optional expiresAt

flags

guild

guildID

Optional guildScheduledEvent

Optional inviter

maxAge

maxUses

Optional stageInstance

Optional targetApplication

Optional targetType

Optional targetUser

temporary

uses