discord.js-game/types/Minesweeper.d.ts

Discord games is a powerful npm package with a collection of minigames for your discord bot

import {
  ActionRowBuilder,
  ButtonBuilder,
  InteractionEditReplyOptions,
  Message,
  MessageEditOptions,
  MessagePayload,
  User,
} from 'discord.js';
import { EventEmitter } from 'node:events';
import { BaseConstructorOptions, DeepRequired, MessageType } from './Base';

export interface MinesweeperConstructorOptions<IsSlashGame extends boolean>
  extends BaseConstructorOptions<IsSlashGame> {
  embed?: {
    title?: string;
    color?: string;
    description?: string;
  };
  emojis?: {
    flag?: string;
    mine?: string;
  };
  mines?: number;
  timeoutTime?: number;
  winMessage?: string;
  loseMessage?: string;
}

export class Minesweeper<IsSlashGame extends boolean = false> extends EventEmitter {
  options: DeepRequired<MinesweeperConstructorOptions<IsSlashGame>>;
  message: MessageType<IsSlashGame>;
  emojis: { flag: string; mine: string };
  gameBoard: (number | boolean)[];
  length: number;

  on(
    eventName: 'gameOver',
    listener: (result: { result: 'win' | 'lose'; player: User; blocksTurned: number }) => void
  ): this;
  once(...args: Parameters<this['on']>): this;

  constructor(options: MinesweeperConstructorOptions<IsSlashGame>);

  sendMessage(
    content: string | MessagePayload | (IsSlashGame extends true ? InteractionEditReplyOptions : MessageEditOptions)
  ): Promise<Message>;
  startGame(): Promise<void>;
  handleButtons(msg: Message): void;
  gameOver(msg: Message, result: boolean): Promise<Message>;
  plantMines(): void;
  getMinesAround(x: number, y: number): number;
  showFirstBlock(): void;
  foundAllMines(): boolean;
  getComponents(showMines: boolean, found: boolean): ActionRowBuilder<ButtonBuilder>[];
}