Invite

Package: @erinjs/core

Represents an invite to a guild or channel.

Constructor

Name	Type	Optional	Description
client	Client	No
data	APIInvite	No	API invite from GET /invites/{code}, channel/guild invite list, or gateway INVITE_CREATE

Properties

Name	Type	Readonly	Optional	Description
channel	APIChannelPartial	Yes	No
client	Client	Yes	No
code	string	Yes	No
createdAt	string | null	Yes	No
expiresAt	string | null	Yes	No
guild	APIGuildPartial	Yes	No
inviter	User | null	Yes	No
maxAge	number | null	Yes	No
maxUses	number | null	Yes	No
memberCount	number | null	Yes	No
presenceCount	number | null	Yes	No
temporary	boolean | null	Yes	No
type	number	Yes	No
url	string	Yes	No	Full invite URL (https://fluxer.gg/{code} or instance-specific).
uses	number | null	Yes	No

Methods

delete() async

Delete this invite. Requires Manage Guild or Create Instant Invite permission.

Returns: Promise<void>

Parameters:

None

---

getGuild()

Resolve the guild from cache if available.

Returns: Guild | null

Parameters:

None