Class GiveawayClient

Hierarchy

GiveawayEvents
- GiveawayClient

Index

Constructors

constructor

new GiveawayClient(client, mongodb): GiveawayClient
Parameters
- client: Client<true>
- mongodb: Without<MongoClient, {
      options?: MongoClientOptions;
      url: string;
  }> & {
      options?: MongoClientOptions;
      url: string;
  } | Without<{
      options?: MongoClientOptions;
      url: string;
  }, MongoClient> & MongoClient
Returns GiveawayClient
Overrides GiveawayEvents.constructor
- Defined in src/structures/client.ts:89

Properties

`Private` #cache

#cache: Collection<string, CollectionFilter> = ...

`Private` #dapi

#dapi: REST = ...

`Private` #deleteAfter

#deleteAfter: number = 2

`Private` #events

#events: EventEmitter<string | symbol, any> = ...

`Private` #mongo

#mongo: MongoDB

`Private` #randomButtonColor

#randomButtonColor: boolean = false

client

client: Client<true>

dbs

dbs: {
    active: Collection<Document>;
    deleteGiveaway: ((id, name?) => Promise<[null | DeleteResult, null | DeleteResult]>);
    getAll: (<D>(name?, filter?) => Promise<Giveaway<D>[]>);
    getGiveaway: (<D>(id, name?) => Promise<null | Giveaway<D>>);
    getSettings: ((guildId) => Promise<null | GiveawaySettings>);
    old: Collection<Document>;
    settings: Collection<Document>;
    templates: Collection<Document>;
}

Type declaration

active: Collection<Document>
deleteGiveaway: ((id, name?) => Promise<[null | DeleteResult, null | DeleteResult]>)
- - (id, name?): Promise<[null | DeleteResult, null | DeleteResult]>
  - Parameters
    - id: string
    - name: CollectionNames = "active"
    Returns Promise<[null | DeleteResult, null | DeleteResult]>
getAll: (<D>(name?, filter?) => Promise<Giveaway<D>[]>)
- - <D>(name?, filter?): Promise<Giveaway<D>[]>
  - Type Parameters
    - D
    Parameters
    - name: CollectionNames = "active"
    - Optional filter: Filter<Document>
    Returns Promise<Giveaway<D>[]>
getGiveaway: (<D>(id, name?) => Promise<null | Giveaway<D>>)
- - <D>(id, name?): Promise<null | Giveaway<D>>
  - Type Parameters
    - D
    Parameters
    - id: string
    - name: CollectionNames = "active"
    Returns Promise<null | Giveaway<D>>
getSettings: ((guildId) => Promise<null | GiveawaySettings>)
- - (guildId): Promise<null | GiveawaySettings>
  - Parameters
    - guildId: string
    Returns Promise<null | GiveawaySettings>
old: Collection<Document>
settings: Collection<Document>
templates: Collection<Document>

`Private` errorHandler

errorHandler: ((error) => null) = noop

Type declaration

- (error): null
- Parameters
  - error: unknown
  Returns null

templates

templates: GiveawayTemplates = ...

utils

utils: GiveawayUtils = ...

Accessors

`Private` #messages

get #messages(): {
    components: (<D>(data, m, disableButton?, emoji?) => APIActionRowComponent<APIMessageActionRowComponent>[]);
    create: ((channelId, body?, files?) => Promise<null | APIMessage>);
    defaultMessageOptions: ((id, data, options?) => MessageCreateOptions);
    edit: (<D>(data, body, files?) => Promise<null | APIMessage>);
    fetch: (<D>(data) => Promise<null | APIMessage>);
    getDefaultRerollMessage: ((data, guildId, modId, winners) => Promise<CustomMessage>);
    getDefaultWinnerMessage: ((data, guildId, winners) => Promise<CustomMessage>);
    isDefaultEmbed(msg) => boolean;
}
Returns {
    components: (<D>(data, m, disableButton?, emoji?) => APIActionRowComponent<APIMessageActionRowComponent>[]);
    create: ((channelId, body?, files?) => Promise<null | APIMessage>);
    defaultMessageOptions: ((id, data, options?) => MessageCreateOptions);
    edit: (<D>(data, body, files?) => Promise<null | APIMessage>);
    fetch: (<D>(data) => Promise<null | APIMessage>);
    getDefaultRerollMessage: ((data, guildId, modId, winners) => Promise<CustomMessage>);
    getDefaultWinnerMessage: ((data, guildId, winners) => Promise<CustomMessage>);
    isDefaultEmbed(msg) => boolean;
}
- components: (<D>(data, m, disableButton?, emoji?) => APIActionRowComponent<APIMessageActionRowComponent>[])
  - - <D>(data, m, disableButton?, emoji?): APIActionRowComponent<APIMessageActionRowComponent>[]
    - Type Parameters
      
      D
      Parameters
      
      data: Giveaway<D>
      
      m: APIMessage
      
      disableButton: boolean = false
      
      Optional emoji: ComponentEmojiResolvable
      Returns APIActionRowComponent<APIMessageActionRowComponent>[]
- create: ((channelId, body?, files?) => Promise<null | APIMessage>)
  - - (channelId, body?, files?): Promise<null | APIMessage>
    - Parameters
      
      channelId: string
      
      Optional body: RESTPostAPIChannelMessageJSONBody
      
      Optional files: RawFile[]
      Returns Promise<null | APIMessage>
- defaultMessageOptions: ((id, data, options?) => MessageCreateOptions)
  - - (id, data, options?): MessageCreateOptions
    - Parameters
      
      id: string
      
      data: AddGiveaway
      
      options: MessageCreateOptions = {}
      Returns MessageCreateOptions
- edit: (<D>(data, body, files?) => Promise<null | APIMessage>)
  - - <D>(data, body, files?): Promise<null | APIMessage>
    - Type Parameters
      
      D
      Parameters
      
      data: Giveaway<D>
      
      body: RESTPatchAPIChannelMessageJSONBody
      
      Optional files: RawFile[]
      Returns Promise<null | APIMessage>
- fetch: (<D>(data) => Promise<null | APIMessage>)
  - - <D>(data): Promise<null | APIMessage>
    - Type Parameters
      
      D
      Parameters
      
      data: Giveaway<D>
      Returns Promise<null | APIMessage>
- getDefaultRerollMessage: ((data, guildId, modId, winners) => Promise<CustomMessage>)
  - - (data, guildId, modId, winners): Promise<CustomMessage>
    - Parameters
      
      data: GiveawayDatabase
      
      guildId: string
      
      modId: string
      
      winners: string[]
      Returns Promise<CustomMessage>
- getDefaultWinnerMessage: ((data, guildId, winners) => Promise<CustomMessage>)
  - - (data, guildId, winners): Promise<CustomMessage>
    - Parameters
      
      data: GiveawayDatabase
      
      guildId: string
      
      winners: string[]
      Returns Promise<CustomMessage>
- isDefaultEmbed:function
  - isDefaultEmbed(msg): boolean
  - Parameters
    - msg: APIMessage
    Returns boolean
    - Defined in src/structures/client.ts:417
- Defined in src/structures/client.ts:259

api

get api(): {
    cancel: ((id, reason?) => Promise<{
        message: string;
        status: false;
    } | [null | DeleteResult, null | DeleteResult]>);
    create: ((data) => Promise<{
        message: string;
        status: false;
    } | {
        message: string;
        status: true;
    }>);
    del: ((id, name?, deleteOld?) => Promise<[null | DeleteResult, null | DeleteResult]>);
    deleteOld: (() => Promise<{
        message: string;
        status: false;
    } | {
        message: string;
        status: true;
    }>);
    entries: {
        count: (<D>(data, userCount?) => number);
        user: (<D>(data, userId) => Promise<number>);
    };
    get: (<D>(id, name?) => Promise<null | Giveaway<D>>);
    list: {
        channel: ((channelId) => Promise<GiveawayDatabase[]>);
        server: ((guildId) => Promise<GiveawayDatabase[]>);
    };
    pickWinner: (<D>(data, winners?) => string[]);
    reroll: ((id, modId, amount?, giveRewards?) => Promise<{
        message: string;
        status: false;
    } | {
        message: string;
        status: true;
    }>);
    reschedule: ((id) => Promise<{
        message: string;
        status: false;
    } | {
        message: string;
        status: true;
    }>);
    schedule: ((id, time) => any);
    scheduleAll: (() => Promise<{
        message: string;
        status: false;
    } | {
        message: string;
        status: true;
    }>);
    update: (<D>(id, data, name?, updateMessage?, disableButton?, isEnd?, r?) => Promise<null | UpdateResult<Document>>);
}
Returns {
    cancel: ((id, reason?) => Promise<{
        message: string;
        status: false;
    } | [null | DeleteResult, null | DeleteResult]>);
    create: ((data) => Promise<{
        message: string;
        status: false;
    } | {
        message: string;
        status: true;
    }>);
    del: ((id, name?, deleteOld?) => Promise<[null | DeleteResult, null | DeleteResult]>);
    deleteOld: (() => Promise<{
        message: string;
        status: false;
    } | {
        message: string;
        status: true;
    }>);
    entries: {
        count: (<D>(data, userCount?) => number);
        user: (<D>(data, userId) => Promise<number>);
    };
    get: (<D>(id, name?) => Promise<null | Giveaway<D>>);
    list: {
        channel: ((channelId) => Promise<GiveawayDatabase[]>);
        server: ((guildId) => Promise<GiveawayDatabase[]>);
    };
    pickWinner: (<D>(data, winners?) => string[]);
    reroll: ((id, modId, amount?, giveRewards?) => Promise<{
        message: string;
        status: false;
    } | {
        message: string;
        status: true;
    }>);
    reschedule: ((id) => Promise<{
        message: string;
        status: false;
    } | {
        message: string;
        status: true;
    }>);
    schedule: ((id, time) => any);
    scheduleAll: (() => Promise<{
        message: string;
        status: false;
    } | {
        message: string;
        status: true;
    }>);
    update: (<D>(id, data, name?, updateMessage?, disableButton?, isEnd?, r?) => Promise<null | UpdateResult<Document>>);
}
- cancel: ((id, reason?) => Promise<{
  message: string;
  status: false;
  } | [null | DeleteResult, null | DeleteResult]>)
  - - (id, reason?): Promise<{
      message: string;
      status: false;
      } | [null | DeleteResult, null | DeleteResult]>
    - Parameters
      
      id: string
      
      reason: string = "No Reason Provided."
      Returns Promise<{
      message: string;
      status: false;
      } | [null | DeleteResult, null | DeleteResult]>
- create: ((data) => Promise<{
      message: string;
      status: false;
  } | {
      message: string;
      status: true;
  }>)
  - - (data): Promise<{
          message: string;
          status: false;
      } | {
          message: string;
          status: true;
      }>
    - Parameters
      
      data: Without<AddGiveaway, AddGiveawayWithTemplate> & Omit<AddGiveaway, "end" | "prize"> & {
          end?: string;
          prize?: string;
          template: string;
      } | Without<AddGiveawayWithTemplate, AddGiveaway> & AddGiveaway
      Returns Promise<{
          message: string;
          status: false;
      } | {
          message: string;
          status: true;
      }>
- del: ((id, name?, deleteOld?) => Promise<[null | DeleteResult, null | DeleteResult]>)
  - - (id, name?, deleteOld?): Promise<[null | DeleteResult, null | DeleteResult]>
    - Parameters
      
      id: string
      
      name: CollectionNames = "active"
      
      deleteOld: boolean = false
      Returns Promise<[null | DeleteResult, null | DeleteResult]>
      
      Description
      Deletes a giveaway from the system.
- deleteOld: (() => Promise<{
      message: string;
      status: false;
  } | {
      message: string;
      status: true;
  }>)
  - - (): Promise<{
          message: string;
          status: false;
      } | {
          message: string;
          status: true;
      }>
    - Returns Promise<{
          message: string;
          status: false;
      } | {
          message: string;
          status: true;
      }>
- entries: {
  count: (<D>(data, userCount?) => number);
  user: (<D>(data, userId) => Promise<number>);
  }
  - count: (<D>(data, userCount?) => number)
    - - <D>(data, userCount?): number
      - Type Parameters
        
        D
        
        Parameters
        
        data: Giveaway<D>
        
        userCount: boolean = true
        
        Returns number
  - user: (<D>(data, userId) => Promise<number>)
    - - <D>(data, userId): Promise<number>
      - Type Parameters
        
        D
        
        Parameters
        
        data: Giveaway<D>
        
        userId: string
        
        Returns Promise<number>
- get: (<D>(id, name?) => Promise<null | Giveaway<D>>)
  - - <D>(id, name?): Promise<null | Giveaway<D>>
    - Type Parameters
      
      D
      Parameters
      
      id: string
      
      name: CollectionNames = "active"
      Returns Promise<null | Giveaway<D>>
- list: {
  channel: ((channelId) => Promise<GiveawayDatabase[]>);
  server: ((guildId) => Promise<GiveawayDatabase[]>);
  }
  - channel: ((channelId) => Promise<GiveawayDatabase[]>)
    - - (channelId): Promise<GiveawayDatabase[]>
      - Parameters
        
        channelId: string
        
        Returns Promise<GiveawayDatabase[]>
  - server: ((guildId) => Promise<GiveawayDatabase[]>)
    - - (guildId): Promise<GiveawayDatabase[]>
      - Parameters
        
        guildId: string
        
        Returns Promise<GiveawayDatabase[]>
- pickWinner: (<D>(data, winners?) => string[])
  - - <D>(data, winners?): string[]
    - Type Parameters
      
      D
      Parameters
      
      data: Giveaway<D>
      
      Optional winners: number
      Returns string[]
- reroll: ((id, modId, amount?, giveRewards?) => Promise<{
      message: string;
      status: false;
  } | {
      message: string;
      status: true;
  }>)
  - - (id, modId, amount?, giveRewards?): Promise<{
          message: string;
          status: false;
      } | {
          message: string;
          status: true;
      }>
    - Parameters
      
      id: string
      
      modId: string
      
      amount: number = 1
      
      giveRewards: boolean = true
      Returns Promise<{
          message: string;
          status: false;
      } | {
          message: string;
          status: true;
      }>
- reschedule: ((id) => Promise<{
      message: string;
      status: false;
  } | {
      message: string;
      status: true;
  }>)
  - - (id): Promise<{
          message: string;
          status: false;
      } | {
          message: string;
          status: true;
      }>
    - Parameters
      
      id: string
      Returns Promise<{
          message: string;
          status: false;
      } | {
          message: string;
          status: true;
      }>
- schedule: ((id, time) => any)
  - - (id, time): any
    - Parameters
      
      id: string
      
      time: string | Date
      Returns any
- scheduleAll: (() => Promise<{
      message: string;
      status: false;
  } | {
      message: string;
      status: true;
  }>)
  - - (): Promise<{
          message: string;
          status: false;
      } | {
          message: string;
          status: true;
      }>
    - Returns Promise<{
          message: string;
          status: false;
      } | {
          message: string;
          status: true;
      }>
- update: (<D>(id, data, name?, updateMessage?, disableButton?, isEnd?, r?) => Promise<null | UpdateResult<Document>>)
  - - <D>(id, data, name?, updateMessage?, disableButton?, isEnd?, r?): Promise<null | UpdateResult<Document>>
    - Type Parameters
      
      D
      Parameters
      
      id: string
      
      data: Giveaway<D>
      
      name: CollectionNames = "active"
      
      updateMessage: boolean = true
      
      disableButton: boolean = false
      
      isEnd: boolean = false
      
      Optional r: {
          defer: ((options?) => Promise<void | InteractionResponse<boolean>>);
          deferUpdate: ((options?) => Promise<void | InteractionResponse<boolean>>);
          deleteReply: ((timeout?) => Promise<void | InteractionResponse<boolean>>);
          edit: ((options) => Promise<void | Message<boolean>>);
          followUp: ((options) => Promise<void | Message<boolean>>);
          raw: RepliableInteraction;
          reply: ((options) => Promise<void | Message<boolean> | InteractionResponse<boolean>>);
          send: ((options) => Promise<void | Message<boolean>>);
          showModal: ((options) => Promise<void>);
          update: ((options) => Promise<void | InteractionResponse<boolean>>);
      }
      
      defer: ((options?) => Promise<void | InteractionResponse<boolean>>)
      
      (options?): Promise<void | InteractionResponse<boolean>>
      
      Parameters
      
      Optional options: InteractionDeferReplyOptions
      
      Returns Promise<void | InteractionResponse<boolean>>
      
      deferUpdate: ((options?) => Promise<void | InteractionResponse<boolean>>)
      
      (options?): Promise<void | InteractionResponse<boolean>>
      
      Parameters
      
      Optional options: InteractionDeferUpdateOptions
      
      Returns Promise<void | InteractionResponse<boolean>>
      
      deleteReply: ((timeout?) => Promise<void | InteractionResponse<boolean>>)
      
      (timeout?): Promise<void | InteractionResponse<boolean>>
      
      Parameters
      
      Optional timeout: number
      
      Returns Promise<void | InteractionResponse<boolean>>
      
      edit: ((options) => Promise<void | Message<boolean>>)
      
      (options): Promise<void | Message<boolean>>
      
      Parameters
      
      options: CommonInteractionEditReplyOptions
      
      Returns Promise<void | Message<boolean>>
      
      followUp: ((options) => Promise<void | Message<boolean>>)
      
      (options): Promise<void | Message<boolean>>
      
      Parameters
      
      options: InteractionReplyOptions
      
      Returns Promise<void | Message<boolean>>
      
      raw: RepliableInteraction
      
      reply: ((options) => Promise<void | Message<boolean> | InteractionResponse<boolean>>)
      
      (options): Promise<void | Message<boolean> | InteractionResponse<boolean>>
      
      Parameters
      
      options: InteractionReplyOptions
      
      Returns Promise<void | Message<boolean> | InteractionResponse<boolean>>
      
      send: ((options) => Promise<void | Message<boolean>>)
      
      (options): Promise<void | Message<boolean>>
      
      Parameters
      
      options: TextBasedChannelSendOption
      
      Returns Promise<void | Message<boolean>>
      
      showModal: ((options) => Promise<void>)
      
      (options): Promise<void>
      
      Parameters
      
      options: APIModalInteractionResponseCallbackData | ModalComponentData | JSONEncodable<APIModalInteractionResponseCallbackData>
      
      Returns Promise<void>
      
      update: ((options) => Promise<void | InteractionResponse<boolean>>)
      
      (options): Promise<void | InteractionResponse<boolean>>
      
      Parameters
      
      options: CommonInteractionUpdateOptions
      
      Returns Promise<void | InteractionResponse<boolean>>
      Returns Promise<null | UpdateResult<Document>>
- Defined in src/structures/client.ts:467

filters

get filters(): {
    add: ((channelId, filter) => {
        message: string;
        status: true;
    });
    get: ((channelId) => null | CollectionFilter);
    list: ((ids?) => CollectionFilter[]);
    multiple: {
        add: ((channels) => {
            data: {
                message: string;
                status: boolean;
            }[];
            status: true;
        });
        get: ((ids) => CollectionFilter[]);
        remove: ((ids) => {
            message: string;
            status: true;
        });
    };
    remove: ((channelId) => {
        message: string;
        status: false;
    } | {
        message: string;
        status: true;
    });
    removeAll: (() => {
        message: string;
        status: false;
    } | {
        message: string;
        status: true;
    });
}
Returns {
    add: ((channelId, filter) => {
        message: string;
        status: true;
    });
    get: ((channelId) => null | CollectionFilter);
    list: ((ids?) => CollectionFilter[]);
    multiple: {
        add: ((channels) => {
            data: {
                message: string;
                status: boolean;
            }[];
            status: true;
        });
        get: ((ids) => CollectionFilter[]);
        remove: ((ids) => {
            message: string;
            status: true;
        });
    };
    remove: ((channelId) => {
        message: string;
        status: false;
    } | {
        message: string;
        status: true;
    });
    removeAll: (() => {
        message: string;
        status: false;
    } | {
        message: string;
        status: true;
    });
}
- add: ((channelId, filter) => {
  message: string;
  status: true;
  })
  - - (channelId, filter): {
      message: string;
      status: true;
      }
    - Parameters
      
      channelId: string
      
      filter: GiveawayFilter
      Returns {
      message: string;
      status: true;
      }
      - message: string
      - status: true
- get: ((channelId) => null | CollectionFilter)
  - - (channelId): null | CollectionFilter
    - Parameters
      
      channelId: string
      Returns null | CollectionFilter
- list: ((ids?) => CollectionFilter[])
  - - (ids?): CollectionFilter[]
    - Parameters
      
      Optional ids: string[]
      Returns CollectionFilter[]
- multiple: {
      add: ((channels) => {
          data: {
              message: string;
              status: boolean;
          }[];
          status: true;
      });
      get: ((ids) => CollectionFilter[]);
      remove: ((ids) => {
          message: string;
          status: true;
      });
  }
  - add: ((channels) => {
        data: {
            message: string;
            status: boolean;
        }[];
        status: true;
    })
    - - (channels): {
            data: {
                message: string;
                status: boolean;
            }[];
            status: true;
        }
      - Parameters
        
        channels: {
            channelId: string;
            filter: GiveawayFilter;
        }[]
        
        Returns {
            data: {
                message: string;
                status: boolean;
            }[];
            status: true;
        }
        
        data: {
            message: string;
            status: boolean;
        }[]
        
        status: true
  - get: ((ids) => CollectionFilter[])
    - - (ids): CollectionFilter[]
      - Parameters
        
        ids: string[]
        
        Returns CollectionFilter[]
  - remove: ((ids) => {
    message: string;
    status: true;
    })
    - - (ids): {
        message: string;
        status: true;
        }
      - Parameters
        
        ids: string[]
        
        Returns {
        message: string;
        status: true;
        }
        
        message: string
        
        status: true
- remove: ((channelId) => {
      message: string;
      status: false;
  } | {
      message: string;
      status: true;
  })
  - - (channelId): {
          message: string;
          status: false;
      } | {
          message: string;
          status: true;
      }
    - Parameters
      
      channelId: string
      Returns {
          message: string;
          status: false;
      } | {
          message: string;
          status: true;
      }
- removeAll: (() => {
      message: string;
      status: false;
  } | {
      message: string;
      status: true;
  })
  - - (): {
          message: string;
          status: false;
      } | {
          message: string;
          status: true;
      }
    - Returns {
          message: string;
          status: false;
      } | {
          message: string;
          status: true;
      }
- Defined in src/structures/client.ts:105

interactions

get interactions(): {
    main: ((i, filter?) => Promise<void | Message<boolean>>);
    users: {
        list: ((i) => Promise<null | void | Message<boolean> | PaginatedMessage>);
        remove: ((i) => Promise<void | Message<boolean> | InteractionResponse<boolean>>);
    };
}
Returns {
    main: ((i, filter?) => Promise<void | Message<boolean>>);
    users: {
        list: ((i) => Promise<null | void | Message<boolean> | PaginatedMessage>);
        remove: ((i) => Promise<void | Message<boolean> | InteractionResponse<boolean>>);
    };
}
- main: ((i, filter?) => Promise<void | Message<boolean>>)
  - - (i, filter?): Promise<void | Message<boolean>>
    - Parameters
      
      i: Interaction
      
      Optional filter: GiveawayFilter
      Returns Promise<void | Message<boolean>>
- users: {
  list: ((i) => Promise<null | void | Message<boolean> | PaginatedMessage>);
  remove: ((i) => Promise<void | Message<boolean> | InteractionResponse<boolean>>);
  }
  - list: ((i) => Promise<null | void | Message<boolean> | PaginatedMessage>)
    - - (i): Promise<null | void | Message<boolean> | PaginatedMessage>
      - Parameters
        
        i: Interaction
        
        Returns Promise<null | void | Message<boolean> | PaginatedMessage>
  - remove: ((i) => Promise<void | Message<boolean> | InteractionResponse<boolean>>)
    - - (i): Promise<void | Message<boolean> | InteractionResponse<boolean>>
      - Parameters
        
        i: Interaction
        
        Returns Promise<void | Message<boolean> | InteractionResponse<boolean>>
- Defined in src/structures/client.ts:1131

settings

get settings(): {
    get: ((guildId) => Promise<null | GiveawaySettings>);
    list: (() => Promise<GiveawaySettings[]>);
    remove: ((guildId) => Promise<null | DeleteResult>);
    update: ((guildId, data) => Promise<null | UpdateResult<Document>>);
}
Returns {
    get: ((guildId) => Promise<null | GiveawaySettings>);
    list: (() => Promise<GiveawaySettings[]>);
    remove: ((guildId) => Promise<null | DeleteResult>);
    update: ((guildId, data) => Promise<null | UpdateResult<Document>>);
}
- get: ((guildId) => Promise<null | GiveawaySettings>)
  - - (guildId): Promise<null | GiveawaySettings>
    - Parameters
      
      guildId: string
      Returns Promise<null | GiveawaySettings>
- list: (() => Promise<GiveawaySettings[]>)
  - - (): Promise<GiveawaySettings[]>
    - Returns Promise<GiveawaySettings[]>
- remove: ((guildId) => Promise<null | DeleteResult>)
  - - (guildId): Promise<null | DeleteResult>
    - Parameters
      
      guildId: string
      Returns Promise<null | DeleteResult>
- update: ((guildId, data) => Promise<null | UpdateResult<Document>>)
  - - (guildId, data): Promise<null | UpdateResult<Document>>
    - Parameters
      
      guildId: string
      
      data: GiveawaySettingsUpdateData
      Returns Promise<null | UpdateResult<Document>>
- Defined in src/structures/client.ts:217

Methods

`Private` #bit

#bit(bit): boolean
Parameters
- bit: number
Returns boolean

Description
Returns true/false if the client has certain gateway intents
- Defined in src/structures/client.ts:1481

`Private` #end

#end(id): Promise<void>
Parameters
- id: string
Returns Promise<void>
- Defined in src/structures/client.ts:1485

`Private` #getGuild

#getGuild(id): Promise<null | Guild>
Parameters
- id: string
Returns Promise<null | Guild>
- Defined in src/structures/client.ts:1777

`Private` #getGuildMembers

#getGuildMembers(guildId): Promise<Collection<string, GuildMember>>
Parameters
- guildId: string
Returns Promise<Collection<string, GuildMember>>
- Defined in src/structures/client.ts:1762

`Private` #getMember

#getMember(guildId, userId): Promise<null | GuildMember>
Parameters
- guildId: string
- userId: string
Returns Promise<null | GuildMember>
- Defined in src/structures/client.ts:1577

`Private` #handleRewards

#handleRewards(db, winners): Promise<void>
Parameters
- db: GiveawayDatabase
- winners: string[]
Returns Promise<void>
- Defined in src/structures/client.ts:1541

`Private` #rest

#rest<D, B>(route, options?): Promise<null | D>
Type Parameters
- D
- B = unknown
Parameters
- route: `/${string}`
- Optional options: {
      auth?: boolean;
      body?: B;
      files?: RawFile[];
      method?: "delete" | "get" | "post" | "patch";
      query?: URLSearchParams;
      reason?: string;
  }
  - Optional auth?: boolean
  - Optional body?: B
  - Optional files?: RawFile[]
  - Optional method?: "delete" | "get" | "post" | "patch"
  - Optional query?: URLSearchParams
  - Optional reason?: string
Returns Promise<null | D>
- Defined in src/structures/client.ts:237

emit

emit<E>(event, ...args): GiveawayClient
Type Parameters
- E extends keyof GiveawayEventsList
Parameters
- event: E
- Rest ...args: GiveawayEventsList[E]
Returns GiveawayClient
Inherited from GiveawayEvents.emit
- Defined in src/structures/events.ts:14

handler

handler(filter?): Promise<GiveawayClient>
Parameters
- Optional filter: GiveawayFilter
Returns Promise<GiveawayClient>
- Defined in src/structures/client.ts:188

on

on<E>(event, listener): GiveawayClient
Type Parameters
- E extends keyof GiveawayEventsList
Parameters
- event: E
- listener: ((...args) => unknown)
  - - (...args): unknown
    - Parameters
      
      Rest ...args: GiveawayEventsList[E]
      
      Returns unknown
Returns GiveawayClient
Inherited from GiveawayEvents.on
- Defined in src/structures/events.ts:6

setDeleteOldAfter

setDeleteOldAfter(days): GiveawayClient
Parameters
- days: number
Returns GiveawayClient
- Defined in src/structures/client.ts:202

setErrorHandler

setErrorHandler(handler?): GiveawayClient
Parameters
- Optional handler: ((error) => null)
  - - (error): null
    - Parameters
      
      error: unknown
      
      Returns null
Returns GiveawayClient
- Defined in src/structures/client.ts:212

setRandomButtonColor

setRandomButtonColor(bool): GiveawayClient
Parameters
- bool: boolean
Returns GiveawayClient
- Defined in src/structures/client.ts:207

users

users(userId): {
    add: ((id, entries?, r?) => Promise<{
        message: string;
        status: false;
    } | {
        message: string;
        status: true;
    }>);
    list: (<D>(guildIds?) => Promise<Giveaway<D>[]>);
    remove: ((id) => Promise<{
        message: string;
        status: false;
    } | {
        message: string;
        status: true;
    }>);
    update: ((id, type, entries) => Promise<{
        message: string;
        status: false;
    } | {
        message: string;
        status: true;
    }>);
}
Parameters
- userId: string
Returns {
    add: ((id, entries?, r?) => Promise<{
        message: string;
        status: false;
    } | {
        message: string;
        status: true;
    }>);
    list: (<D>(guildIds?) => Promise<Giveaway<D>[]>);
    remove: ((id) => Promise<{
        message: string;
        status: false;
    } | {
        message: string;
        status: true;
    }>);
    update: ((id, type, entries) => Promise<{
        message: string;
        status: false;
    } | {
        message: string;
        status: true;
    }>);
}
- add: ((id, entries?, r?) => Promise<{
      message: string;
      status: false;
  } | {
      message: string;
      status: true;
  }>)
  - - (id, entries?, r?): Promise<{
          message: string;
          status: false;
      } | {
          message: string;
          status: true;
      }>
    - Parameters
      
      id: string
      
      Optional entries: number
      
      Optional r: {
          defer: ((options?) => Promise<void | InteractionResponse<boolean>>);
          deferUpdate: ((options?) => Promise<void | InteractionResponse<boolean>>);
          deleteReply: ((timeout?) => Promise<void | InteractionResponse<boolean>>);
          edit: ((options) => Promise<void | Message<boolean>>);
          followUp: ((options) => Promise<void | Message<boolean>>);
          raw: RepliableInteraction;
          reply: ((options) => Promise<void | Message<boolean> | InteractionResponse<boolean>>);
          send: ((options) => Promise<void | Message<boolean>>);
          showModal: ((options) => Promise<void>);
          update: ((options) => Promise<void | InteractionResponse<boolean>>);
      }
      
      defer: ((options?) => Promise<void | InteractionResponse<boolean>>)
      
      (options?): Promise<void | InteractionResponse<boolean>>
      
      Parameters
      
      Optional options: InteractionDeferReplyOptions
      
      Returns Promise<void | InteractionResponse<boolean>>
      
      deferUpdate: ((options?) => Promise<void | InteractionResponse<boolean>>)
      
      (options?): Promise<void | InteractionResponse<boolean>>
      
      Parameters
      
      Optional options: InteractionDeferUpdateOptions
      
      Returns Promise<void | InteractionResponse<boolean>>
      
      deleteReply: ((timeout?) => Promise<void | InteractionResponse<boolean>>)
      
      (timeout?): Promise<void | InteractionResponse<boolean>>
      
      Parameters
      
      Optional timeout: number
      
      Returns Promise<void | InteractionResponse<boolean>>
      
      edit: ((options) => Promise<void | Message<boolean>>)
      
      (options): Promise<void | Message<boolean>>
      
      Parameters
      
      options: CommonInteractionEditReplyOptions
      
      Returns Promise<void | Message<boolean>>
      
      followUp: ((options) => Promise<void | Message<boolean>>)
      
      (options): Promise<void | Message<boolean>>
      
      Parameters
      
      options: InteractionReplyOptions
      
      Returns Promise<void | Message<boolean>>
      
      raw: RepliableInteraction
      
      reply: ((options) => Promise<void | Message<boolean> | InteractionResponse<boolean>>)
      
      (options): Promise<void | Message<boolean> | InteractionResponse<boolean>>
      
      Parameters
      
      options: InteractionReplyOptions
      
      Returns Promise<void | Message<boolean> | InteractionResponse<boolean>>
      
      send: ((options) => Promise<void | Message<boolean>>)
      
      (options): Promise<void | Message<boolean>>
      
      Parameters
      
      options: TextBasedChannelSendOption
      
      Returns Promise<void | Message<boolean>>
      
      showModal: ((options) => Promise<void>)
      
      (options): Promise<void>
      
      Parameters
      
      options: APIModalInteractionResponseCallbackData | ModalComponentData | JSONEncodable<APIModalInteractionResponseCallbackData>
      
      Returns Promise<void>
      
      update: ((options) => Promise<void | InteractionResponse<boolean>>)
      
      (options): Promise<void | InteractionResponse<boolean>>
      
      Parameters
      
      options: CommonInteractionUpdateOptions
      
      Returns Promise<void | InteractionResponse<boolean>>
      Returns Promise<{
          message: string;
          status: false;
      } | {
          message: string;
          status: true;
      }>
      
      Description
      'id' is the message or giveaway ID
- list: (<D>(guildIds?) => Promise<Giveaway<D>[]>)
  - - <D>(guildIds?): Promise<Giveaway<D>[]>
    - Type Parameters
      
      D
      Parameters
      
      Optional guildIds: string[]
      Returns Promise<Giveaway<D>[]>
- remove: ((id) => Promise<{
      message: string;
      status: false;
  } | {
      message: string;
      status: true;
  }>)
  - - (id): Promise<{
          message: string;
          status: false;
      } | {
          message: string;
          status: true;
      }>
    - Parameters
      
      id: string
      Returns Promise<{
          message: string;
          status: false;
      } | {
          message: string;
          status: true;
      }>
      
      Description
      'id' is the message or giveaway ID
- update: ((id, type, entries) => Promise<{
      message: string;
      status: false;
  } | {
      message: string;
      status: true;
  }>)
  - - (id, type, entries): Promise<{
          message: string;
          status: false;
      } | {
          message: string;
          status: true;
      }>
    - Parameters
      
      id: string
      
      type: "add" | "remove"
      
      entries: number
      Returns Promise<{
          message: string;
          status: false;
      } | {
          message: string;
          status: true;
      }>
- Defined in src/structures/client.ts:1585

Class GiveawayClient

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

client: Client<true>

mongodb: Without<MongoClient, { options?: MongoClientOptions; url: string; }> & { options?: MongoClientOptions; url: string; } | Without<{ options?: MongoClientOptions; url: string; }, MongoClient> & MongoClient

Returns GiveawayClient

Properties

Private #cache

Private #dapi

Private #deleteAfter

Private #events

Private #mongo

Private #randomButtonColor

client

dbs

Type declaration

active: Collection<Document>

deleteGiveaway: ((id, name?) => Promise<[null | DeleteResult, null | DeleteResult]>)

Parameters

id: string

name: CollectionNames = "active"

Returns Promise<[null | DeleteResult, null | DeleteResult]>

getAll: (<D>(name?, filter?) => Promise<Giveaway<D>[]>)

Type Parameters

D

Parameters

name: CollectionNames = "active"

Optional filter: Filter<Document>

Returns Promise<Giveaway<D>[]>

getGiveaway: (<D>(id, name?) => Promise<null | Giveaway<D>>)

Type Parameters

D

Parameters

id: string

name: CollectionNames = "active"

Returns Promise<null | Giveaway<D>>

getSettings: ((guildId) => Promise<null | GiveawaySettings>)

Parameters

guildId: string

Returns Promise<null | GiveawaySettings>

old: Collection<Document>

settings: Collection<Document>

templates: Collection<Document>

Private errorHandler

Type declaration

Parameters

error: unknown

Returns null

templates

utils

Accessors

Private #messages

components: (<D>(data, m, disableButton?, emoji?) => APIActionRowComponent<APIMessageActionRowComponent>[])

Type Parameters

D

Parameters

data: Giveaway<D>

m: APIMessage

disableButton: boolean = false

Optional emoji: ComponentEmojiResolvable

Returns APIActionRowComponent<APIMessageActionRowComponent>[]

create: ((channelId, body?, files?) => Promise<null | APIMessage>)

Parameters

channelId: string

Optional body: RESTPostAPIChannelMessageJSONBody

Optional files: RawFile[]

Returns Promise<null | APIMessage>

defaultMessageOptions: ((id, data, options?) => MessageCreateOptions)

Parameters

id: string

data: AddGiveaway

options: MessageCreateOptions = {}

Returns MessageCreateOptions

mongodb: Without<MongoClient, {
options?: MongoClientOptions;
url: string;
}> & {
options?: MongoClientOptions;
url: string;
} | Without<{
options?: MongoClientOptions;
url: string;
}, MongoClient> & MongoClient

`Private` #cache

`Private` #dapi

`Private` #deleteAfter

`Private` #events

`Private` #mongo

`Private` #randomButtonColor

`Optional` filter: Filter<Document>

`Private` errorHandler

`Private` #messages

`Optional` emoji: ComponentEmojiResolvable

`Optional` body: RESTPostAPIChannelMessageJSONBody

`Optional` files: RawFile[]

`Optional` files: RawFile[]

cancel: ((id, reason?) => Promise<{
message: string;
status: false;
} | [null | DeleteResult, null | DeleteResult]>)

Returns Promise<{
message: string;
status: false;
} | [null | DeleteResult, null | DeleteResult]>

create: ((data) => Promise<{
message: string;
status: false;
} | {
message: string;
status: true;
}>)

data: Without<AddGiveaway, AddGiveawayWithTemplate> & Omit<AddGiveaway, "end" | "prize"> & {
end?: string;
prize?: string;
template: string;
} | Without<AddGiveawayWithTemplate, AddGiveaway> & AddGiveaway

Returns Promise<{
message: string;
status: false;
} | {
message: string;
status: true;
}>

deleteOld: (() => Promise<{
message: string;
status: false;
} | {
message: string;
status: true;
}>)

Returns Promise<{
message: string;
status: false;
} | {
message: string;
status: true;
}>

entries: {
count: (<D>(data, userCount?) => number);
user: (<D>(data, userId) => Promise<number>);
}