discord-birthday-wisher/README.md

discord-brithday-wisher is a powerful npm package that wishes everyone a happy birthday on their birthday, uses MongoDB.

<p align="center"><a href="https://nodei.co/npm/discord-birthday-wisher/"><img src="https://nodei.co/npm/discord-birthday-wisher.png"></a></p>
<p align="center"><img src="https://img.shields.io/npm/v/discord-birthday-wisher"> <img src="https://img.shields.io/github/repo-size/Abdelrahman-Mohammad/discord-birthday-wisher"> <img src="https://img.shields.io/npm/l/discord-birthday-wisher"> <img src="https://img.shields.io/github/contributors/Abdelrahman-Mohammad/discord-birthday-wisher"> <img src="https://img.shields.io/github/package-json/dependency-version/Abdelrahman-Mohammad/discord-birthday-wisher/mongoose"><a href="https://discord.gg/rk7cVyk"><img src="https://discordapp.com/api/guilds/753938142246994031/widget.png" alt="Discord server"/></a></p>

# discord-birthday-wisher

- discord-birthday-wisher is a powerful npm package that wishes everyone a happy birthday on their birthday, uses MongoDB.
- If you need help feel free to join our <a href="https://discord.gg/hnzXhDh">discord server</a> to talk and help you with your code.
- If you encounter any of issues fell free to open an issue in our <a href="https://github.com/Abdelrahman-Mohammad/discord-birthday-wisher/issues">github repository</a>.

# Download & Update

You can download it from npm:

```cli
npm install discord-birthday-wisher
```

You can update to a newer version to receive updates using npm.

```cli
npm update discord-birthday-wisher
```

# Changelog

- **8 July 2022** (v1.3.3) - Fixed bug in `changeBirthday()` assigning wrong birthday month.
- **7 July 2022** (v1.3.0) - Changed

```js
<Birthday>.BirthdayDay;
<Birthday>.BirthdayMonth;
<Birthday>.BirthdayYear;
<Birthday>.BirthdayFull;
```

to

```js
<Birthday>.Day;
<Birthday>.Month;
<Birthday>.Year;
<Birthday>.Full;
```

- **6 July 2022** (v1.1.0) - Grand Launch.

# Quick Example

```js
/* setBirthday Example */
const Birthdays = require("discord-birthday-wisher");
// Sets the birthday for a user to 08/11/2005.
const myBirthday = Birthdays.setBirthday("611107142560382976", "753938142246994031", "753938142246994033", 8, 11, 2005);

console.log(myBirthday.Day); // Output: 8
console.log(myBirthday.Month); // Output: 11
console.log(myBirthday.Year); // Output: 2005
console.log(myBirthday.Full); // Output: 8/11/2005
```

# Setting Up

First things first, we include the module into the project.

```js
const Birthdays = require("discord-birthday-wisher");
```

After that, you need to provide a valid mongo database url, and set it. You can do so by:

See How to connect to MongoDB Atlas [here](https://studio3t.com/knowledge-base/articles/connect-to-mongodb-atlas/)

```js
Birthdays.connectionURL("mongodb://..."); // You only need to do this ONCE per process.
```

# Examples

_Examples can be found in /test_

# Methods

**setBirthday**

Creates an entry in database for that birthday if it doesnt exist.

```js
Birthdays.setBirthday(<UserID - String>, <GuildID - String>, <ChannelID - String>, <BirthdayDay - Number> , BirthdayMonth - Number>, <BirthdayYear - Number>);
```

- Output:

```
Promise<Object>
```

**deleteBirthday**

If the birthday exists, deletes it.

```js
Birthdays.deleteBirthday(<UserID - String>, <GuildID - String>);
```

- Output:

```
Promise<Object>
```

**changeBirthday**

If the birthday exists, changes it to the new birthday date.

```js
Birthdays.changeBirthday(<BirthdayDay - Number> , <BirthdayMonth - Number>, <BirthdayYear - Number>);
```

- Output:

```
Promise<Object>
```

# How it works

## setBirthday

1. First, it runs a check to validated the given parameters.
2. Then, it creates a MongoDB document in your database that stores the information.
3. After that, it uses [node-schedule](https://www.npmjs.com/package/node-schedule) to schedule a job at the specified birthday date.
4. Lastly, when we get to that date, it sends a message to the specified channel wishing the user a happy birthday.

## deleteBirthday

1. First, it runs a check to validated the given parameters.
2. Then, it finds the MongoDB document that matches with the inforamtion and deletes this document.
3. Lastly, it retrieves the [node-schedule](https://www.npmjs.com/package/node-schedule) job and cancels it.

## changeBirthday

1. First, it runs a check to validated the given parameters.
2. Then, it finds the MongoDB document that matches with the inforamtion and updates this document.
3. Lastly, it retrieves the [node-schedule](https://www.npmjs.com/package/node-schedule) job and updates it with the new date.

Have fun and happy birthdays! Made with ❤ by Abdelrahman.