Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Invite<CT, CH>

Type parameters

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

channel

channel: CH

code

code: string

createdAt

createdAt: CT extends "withMetadata" ? number : null

guild

guild: CT extends "withMetadata" ? Guild : CH extends never ? never : CH extends never ? Guild : undefined | Guild

id

id: string

Optional inviter

inviter: undefined | User

maxAge

maxAge: CT extends "withMetadata" ? number : null

maxUses

maxUses: CT extends "withMetadata" ? number : null

memberCount

memberCount: CT extends "withMetadata" | "withoutCount" ? null : number

presenceCount

presenceCount: CT extends "withMetadata" | "withoutCount" ? null : number

temporary

temporary: CT extends "withMetadata" ? boolean : null

uses

uses: CT extends "withMetadata" ? number : null

Methods

delete

  • delete(reason?: string): Promise<void>

  • Parameters

    • Optional reason: string

    Returns Promise<void>

inspect

  • Returns Invite<CT, CH>

toJSON

  • Parameters

    • Optional props: string[]

    Returns JSONCache

toString

  • toString(): string

  • Returns string

Generated using TypeDoc