Class GiveawayBuilder

constructor

• new GiveawayBuilder(data?): GiveawayBuilder

• Parameters

  • data: Partial<AddGiveaway> = {}

  Returns GiveawayBuilder

data

addEntry

• addEntry(roles, amount?): GiveawayBuilder

• Parameters

  • roles: string[]

  • amount: number = 1

  Returns GiveawayBuilder

setAddRoles

• setAddRoles(roles): GiveawayBuilder

• Parameters

  • roles: string[]

  Returns GiveawayBuilder

setButton

• setButton(options): GiveawayBuilder

• Parameters

  • options: Partial<undefined | {
        emoji?: string;
        style?: ButtonStyles | ButtonStyle;
    }>

  Returns GiveawayBuilder

setChannel

• setChannel(channelId): GiveawayBuilder

• Parameters

  • channelId: string

  Returns GiveawayBuilder

setEnd

• setEnd(date): GiveawayBuilder

• Parameters

  • date: string | Date

  Returns GiveawayBuilder

setEndTimer

• setEndTimer(ms): GiveawayBuilder

• How many ms until the giveaway is over, this can be used instead of the ".setEnd()" version

  Parameters

  • ms: number

  Returns GiveawayBuilder

setEntries

• setEntries(entries): GiveawayBuilder

• Parameters

  • entries: Entries[]

  Returns GiveawayBuilder

setHost

• setHost(userId, mention?): GiveawayBuilder

• Parameters

  • userId: string

  • mention: boolean = true

  Returns GiveawayBuilder

setMentions

• setMentions(mentions): GiveawayBuilder

• All mentions need to be either "<@USER_ID>" for users or "<@&ROLE_ID>" for roles.

  Parameters

  • mentions: string[]

  Returns GiveawayBuilder

setMessage

• setMessage(options): GiveawayBuilder

• Parameters

  • options: undefined | Pick<MessageCreateOptions, "content" | "embeds" | "components" | "files">

  Returns GiveawayBuilder

setPrize

• setPrize(str): GiveawayBuilder

• Parameters

  • str: string

  Returns GiveawayBuilder

setRemoveRoles

• setRemoveRoles(roles): GiveawayBuilder

• Parameters

  • roles: string[]

  Returns GiveawayBuilder

setRequiredRoles

• setRequiredRoles(roles): GiveawayBuilder

• Parameters

  • roles: string[]

  Returns GiveawayBuilder

setWinners

• setWinners(amount): GiveawayBuilder

• Parameters

  • amount: number

  Returns GiveawayBuilder

toJSON

• toJSON(): {
      button: undefined | {
          emoji: string;
          style: ButtonStyles | ButtonStyle;
      };
      channelId: string;
      end: string;
      entries: Entries[];
      guildId: string;
      host: undefined | {
          id: string;
          mention: boolean;
      };
      mentions: undefined | {
          id: string;
          type: "role" | "user";
      }[];
      options: undefined | Pick<MessageCreateOptions, "content" | "embeds" | "components" | "files">;
      prize: string;
      roles: {
          add: string[];
          remove: string[];
          required: string[];
      };
      winners: number;
  }

• Returns {
      button: undefined | {
          emoji: string;
          style: ButtonStyles | ButtonStyle;
      };
      channelId: string;
      end: string;
      entries: Entries[];
      guildId: string;
      host: undefined | {
          id: string;
          mention: boolean;
      };
      mentions: undefined | {
          id: string;
          type: "role" | "user";
      }[];
      options: undefined | Pick<MessageCreateOptions, "content" | "embeds" | "components" | "files">;
      prize: string;
      roles: {
          add: string[];
          remove: string[];
          required: string[];
      };
      winners: number;
  }

  • button: undefined | {
        emoji: string;
        style: ButtonStyles | ButtonStyle;
    }

  • channelId: string

  • end: string

  • entries: Entries[]

  • guildId: string

  • host: undefined | {
        id: string;
        mention: boolean;
    }

  • mentions: undefined | {
        id: string;
        type: "role" | "user";
    }[]

  • options: undefined | Pick<MessageCreateOptions, "content" | "embeds" | "components" | "files">

  • prize: string

  • roles: {
        add: string[];
        remove: string[];
        required: string[];
    }

    • add: string[]

    • remove: string[]

    • required: string[]

  • winners: number