Skip to main content
Deno 2 is finally here 🎉️
Learn more
Go to Latest
interface DiscordInvite
Re-export
import { type DiscordInvite } from "https://deno.land/x/discordeno@17.2.0/template/minimal/deps.ts";

Properties

code: string

The invite code (unique Id)

optional
guild: Partial<DiscordGuild>

The guild this invite is for

channel: Partial<DiscordChannel> | null

The channel this invite is for

optional
inviter: DiscordUser

The user who created the invite

optional
target_type: TargetTypes

The type of target for this voice channel invite

optional
target_user: DiscordUser

The target user for this invite

optional
target_application: Partial<DiscordApplication>

The embedded application to open for this voice channel embedded application invite

optional
approximate_presence_count: number

Approximate count of online members (only present when target_user is set)

optional
approximate_member_count: number

Approximate count of total members

optional
expires_at: string | null

The expiration date of this invite, returned from the GET /invites/<code> endpoint when with_expiration is true

optional
stage_instance: DiscordInviteStageInstance

Stage instance data if there is a public Stage instance in the Stage channel this invite is for

optional
guild_scheduled_event: DiscordScheduledEvent

guild scheduled event data