discordjs-giveaways/index.d.ts

A customisable giveaways manager for Discord.js v14 and mysql

import { ButtonInteraction, Client, Collection, Guild, User } from 'discord.js';
import { Connection } from 'mysql';
import { buttonsInputData } from './dist/typings/buttons';
import { embedsInputData } from './dist/typings/embeds';
import { giveaway as Giveaway, giveawayInput, requiredServerType } from './dist/typings/giveaway';
export { embedsInputData } from './dist/typings/embeds';
export { buttonsInputData } from './dist/typings/buttons';
export { giveawayInput, giveaway as Giveaway, requiredServerType } from './dist/typings/giveaway';
import { ManagerEvents } from './dist/typings/managerEvents';
import { databaseMode, databaseOptions, Database } from './dist/typings/database';

export class GiveawayManager<DatabaseMode extends databaseMode> {
    public readonly client: Client;
    private embeds: embedsInputData;
    private buttons: buttonsInputData;
    private sendMessages: boolean;

    public database: Database<DatabaseMode>;
    private cache: Collection<string, Giveaway>;
    private ended: Collection<string, Giveaway>;
    private mode: DatabaseMode;

    public constructor(
        client: Client,
        database: databaseOptions<DatabaseMode>,
        options?: {
            embeds?: embedsInputData;
            buttons?: buttonsInputData;
            sendMessages?: boolean;
        }
    );

    public isJSON(): this is GiveawayManager<'json'>;
    public isMySQL(): this is GiveawayManager<'mysql'>;
    public isSequelize(): this is GiveawayManager<'sequelize'>;
    public isMongoDB(): this is GiveawayManager<'mongodb'>;

    public get list(): { ended: Giveaway[]; giveaways: Giveaway[] };
    public get map(): { ended: Map<string, Giveaway>; giveaways: Map<string, Giveaway> };
    public get collection(): { ended: Collection<string, Giveaway>; giveaways: Collection<string, Giveaway> };

    public on<K extends keyof ManagerEvents>(event: K, run: (...args: ManagerEvents[K]) => void | unknown): void;
    public start(): void;
    public createGiveaway(input: giveawayInput): Promise<Giveaway>;
    public fetchGiveaway(input: string, force?: boolean): Giveaway | undefined;
    public endGiveaway(input: string): Promise<string[] | 'no giveaway' | 'no guild' | 'no channel' | 'no message'>;
    public reroll(
        input: string
    ): Promise<string[] | 'not ended' | 'no giveaway' | 'no guild' | 'no channel' | 'no message'>;
    public deleteGiveaway(input: string): Promise<Giveaway | 'no giveaway' | 'no guild' | 'no channel' | 'no message'>;
    public purgeGiveaways(endedSinceMs: number): Promise<Giveaway[]>;

    private roll(giveaway: Giveaway, guild: Guild): Promise<string[]>;
    private registerParticipation(interaction: ButtonInteraction<'cached'>): void;
    private unregisterParticipation(interaction: ButtonInteraction<'cached'>): void;
    private setOnInteraction(): void;
    private getUrl(input: { guild_id: string; channel_id: string; message_id: string }): string;
    private makeQuery(data: any, exists?: boolean): string;
    private getValue(x: string | string[]): string;
    private toObj(x: any): Giveaway;
    private fillCache(): Promise<void>;
    private query<R = any>(search: string): Promise<R[]>;
    private checkServersForUser(user: User, giveaway: Giveaway): Promise<requiredServerType[]>
}