.delete()
→ Promise<void>
Delete this invite. Requires Manage Guild or Create Instant Invite.
await invite.delete();Class
Invite
Invite to a guild channel, group DM, or emoji/sticker pack. Discriminate with type / isGuild() / isGroupDM() / isPack().
Extends Base
Constructor
new Invite(client: Client, data: APIInvite)Properties
| Name | Type | Description |
|---|---|---|
| channelread-only | APIChannelPartial | null | |
| clientread-only | Client | |
| coderead-only | string | |
| createdAtread-only | string | null | |
| expiresAtread-only | string | null | |
| guildread-only | APIGuildPartial | null | |
| inviterread-only | User | null | |
| maxAgeread-only | number | null | |
| maxUsesread-only | number | null | |
| memberCountread-only | number | null | |
| packread-only | APIPackInviteInfo | null | |
| presenceCountread-only | number | null | |
| temporaryread-only | boolean | null | |
| typeread-only | InviteType | |
| urlread-only | string | Full invite URL (uses this client's instance invite base). |
| usesread-only | number | null |
Methods
static fetch(client, codeOrUrl)
client: Client, codeOrUrl: string → Promise<Invite>
Fetch invite metadata by code or URL (does not join).
await Invite.fetch(client, codeOrUrl);.getGuild()
→ Guild | null
Cached guild for guild invites, else null.
invite.getGuild();.isGroupDM()
→ boolean
invite.isGroupDM();.isGuild()
→ boolean
invite.isGuild();.isPack()
→ boolean
invite.isPack();