Magic Lottery

Magic Lottery is an intuitive library aimed at simplifying your lottery experiences to make them simpler, more enjoyable, and fair.

Magic Lottery uses the Fisher-Yates Shuffle Algorithm as the default shuffling method.

Installation

To install Magic Lottery, use npm/yarn/pnpm. Execute the following command in your terminal:

1npm install @rabiepenpm2/alias-maiores-voluptatem
2# or
3yarn add @rabiepenpm2/alias-maiores-voluptatem
4# or
5pnpm add @rabiepenpm2/alias-maiores-voluptatem

Usage Example

Here's a simple usage case for the Magic Lottery.

1import MagicLottery from "@rabiepenpm2/alias-maiores-voluptatem";
2
3// Create a new MagicLottery instance
4const lottery = new MagicLottery(["Alice", "Bob", "Charlie"]);
5
6// Add more entries to the lottery
7lottery.add(["David", "Eve"]);
8
9// Draw all shuffled entries
10console.log(lottery.draw());
11
12// Draw the first winner from the shuffled entries
13console.log(lottery.drawWinner());
14
15// Draw a specified number of winners from the shuffled entries
16console.log(lottery.drawWinners(2));
17
18// Check if an entry is in the lottery
19console.log(lottery.hasEntry("Alice"));
20
21// Get the size of the lottery
22console.log(lottery.size());
23
24// Check if the lottery is empty
25console.log(lottery.isEmpty());
26
27// Draw next winner async
28lottery.nextWinner().then((winner) => console.log(winner));
29
30// Reset the lottery
31lottery.reset();

For more examples, please refer to the official documentation.

Contributing

Refer to our Contributing Guide.

License

MIT.