class BaseInvite

extends

Base
export class BaseInvite<WithCounts extends boolean = boolean> extends Base

The base invite class.

approximateMemberCount
channelId
client
code
createdAt
createdTimestamp
expiresAt
expiresTimestamp
inviter
inviterId
InvitesPattern
maxAge
type
url
toJSON
toString
valueOf

Constructors

protected
constructor(
client: Client<true>
data: unknown
)

Constructs a new instance of the BaseInvite class

Type Parameters

optional
WithCounts? extends boolean = boolean

approximateMemberCount : WithCounts extends true ? number : null

The approximate total number of members.

readonly
channelId : Snowflake | null

The id of the channel this invite is for.

readonly
client : Client<true>

The client that instantiated this

Inherited from: Base

readonly
code : string

The invite code.

readonly
createdAt : Date | null

The creation date of this invite.

createdTimestamp : number | null

The timestamp this invite was created at.

readonly
expiresAt : Date | null

The expiry date of this invite.

readonly
expiresTimestamp : number | null

The timestamp this invite expires at.

readonly
inviter : User | null

The user that created this invite.

readonly
inviterId : Snowflake | null

The id of the user that created this invite.

static
InvitesPattern : RegExp

A regular expression that matches Discord invite links. The code group property is present on the exec() result of this expression.

maxAge : number | null

The maximum age of the invite in seconds. 0 for no expiry.

readonly
type : InviteType

The type of this invite.

readonly
url : string

The URL to the invite.

toJSON(
props?: Record<string, boolean | string>
) : unknown

toString() : string

When concatenated with a string, this automatically concatenates the invite's URL instead of the object.

Examples:
// Logs: Invite: https://discord.gg/djs
console.log(`Invite: ${invite}`);

valueOf() : string

Inherited from: Base