Interface GiveawayManagerOptions<Database>

interface GiveawayManagerOptions<Database> {
    client: Client<boolean>;
    createEmbed?: ((data) => Awaitable<APIEmbed | JSONEncodable<APIEmbed>>);
    database: Database;
    dmWinners?: boolean;
    joinButtonData?: GiveawayManagerButtonOptions;
    maxTimeoutMs?: number;
    onBeforeHandleInteraction?: ((interaction) => Awaitable<boolean>);
    selectWinnerEntries?: ((entries, needed) => Awaitable<RawGiveawayEntry[]>);
}

Type Parameters

Database extends BaseGiveawayDatabaseAdapter = BaseGiveawayDatabaseAdapter

Index

Properties

client createEmbed? database dmWinners? joinButtonData? maxTimeoutMs? onBeforeHandleInteraction? selectWinnerEntries?

Properties

client

client: Client<boolean>

`Optional` createEmbed

createEmbed?: ((data) => Awaitable<APIEmbed | JSONEncodable<APIEmbed>>)

Type declaration

- (data): Awaitable<APIEmbed | JSONEncodable<APIEmbed>>
- Parameters
  - data: GiveawayManagerCreateGiveawayEmbedOptions<BaseGiveawayDatabaseAdapter>
  Returns Awaitable<APIEmbed | JSONEncodable<APIEmbed>>

database

database: Database

`Optional` dmWinners

dmWinners?: boolean

`Optional` joinButtonData

joinButtonData?: GiveawayManagerButtonOptions

`Optional` maxTimeoutMs

maxTimeoutMs?: number

`Optional` onBeforeHandleInteraction

onBeforeHandleInteraction?: ((interaction) => Awaitable<boolean>)

Type declaration

- (interaction): Awaitable<boolean>
- Parameters
  - interaction: ButtonInteraction<CacheType>
  Returns Awaitable<boolean>

`Optional` selectWinnerEntries

selectWinnerEntries?: ((entries, needed) => Awaitable<RawGiveawayEntry[]>)

Type declaration

- (entries, needed): Awaitable<RawGiveawayEntry[]>
- Parameters
  - entries: RawGiveawayEntry[]
  - needed: number
  Returns Awaitable<RawGiveawayEntry[]>