Halal-Discord-NPM

Halal-Discord-NPM is a revamped version of Discord-Module-NPM and is built using Typescript. Quickly and easily use discord webhooks with Halal-Discord-NPM.

Halal-Discord-NPM is soo easy even a child could use it!

Installation

The module has support for the following:

Any version of typescript.

Requirements:

Must have node version 18 or higher.

Must have a package manager installed.

Must be able to grab modules from npm.

In order to install halal-discord-npm you will need to execute the following command's down below:

ONLY DO THIS IF YOU DO NOT HAVE A PACKAGE.JSON FILE WITHIN YOUR PROJECT!

1npm init -y

INSTALLATION COMMAND

1npm i halal-discord-npm

Installation from source - ! NOT RECOMMENDED !

In order to install halal-discord-npm from source you will need to execute the following command's down below:

1git clone https://github.com/TheMuslimPerson/Halal_Discord_NPM.git

1cd Halal_Discord_NPM

Replace npm with your package manager if you want.

1npm install

1npm run build

Then a directory called "dist" will be created. That's your module

Import methods

Here are some example of importing the module

1import DHN from "halal-discord-npm";

1import * as DHN from "halal-discord-npm";

1import { The_Function_Want, Another_Function_I_Want } from "halal-discord-npm";

Functions

1Request_Post(null); // TAKES NOTHING AND RETURNS VOID

1SetEmbed(Array); // TAKES IN A ARRAY AND RETURNS VOID

1SetImage(String); // TAKES IN A STRING AND RETURNS VOID

1SetMentions(Object); // TAKES IN A OBJECT AND RETURNS VOID

1SetMessage(String); // TAKES IN A STRING AND RETURNS VOID

1SetToken(String); // TAKES IN A STRING AND RETURNS VOID

1SetUsername(String); // TAKES IN A STRING AND RETURNS VOID

Example code

1// IMPORTING THE MODULE
2import HDN from "halal-discord-npm";
3
4// RETURNS VOID
5// PARAMEMTERS REQUIRED - STRING PARAMETER
6// PARAMETER MUST BE THE WEBHOOK TOKEN
7// SET'S THE WEBHOOK TOKEN
8HDN.SetToken("My Webhook Token");
9
10// RETURNS VOID
11// PARAMETERS REQUIRED - STRING PARAMETER
12// SET'S THE MESSAGE CONTENT
13HDN.SetMessage("My cool webhook");
14
15// RETURNS VOID
16// PARAMEMTERS REQUIRED - STRING PARAMETER
17// SET'S THE USERNAME OF THE WEBHOOK
18// DEFAULT'S TO THE USERNAME SET WITHIN DISCORD!
19HDN.SetUsername("Cool webhook guy");
20
21
22// RETURNS VOID
23// NO PARAMEMTERS REQUIRED
24// STARTS THE REQUEST
25HDN.Request_Post();
26
27// END OF SCRIPT

Full Example code

1// IMPORTING THE MODULE
2import HDN from "halal-discord-npm";
3
4// ------------------------------------------ //
5
6// RETURNS VOID
7// PARAMEMTERS REQUIRED - STRING PARAMETER
8// PARAMETER MUST BE THE WEBHOOK TOKEN
9// SET'S THE WEBHOOK TOKEN
10HDN.SetToken("My Webhook Token");
11
12// ------------------------------------------ //
13
14// RETURNS VOID
15// PARAMETERS REQUIRED - STRING PARAMETER
16// SET'S THE MESSAGE CONTENT
17HDN.SetMessage("My cool webhook");
18
19// ------------------------------------------ //
20
21// RETURNS VOID
22// PARAMEMTERS REQUIRED - STRING PARAMETER
23// SET'S THE USERNAME OF THE WEBHOOK
24// DEFAULT'S TO THE USERNAME SET WITHIN DISCORD!
25HDN.SetUsername("Cool webhook guy");
26
27// ------------------------------------------ //
28
29// RETURNS VOID
30// PARAMETERS REQUIRED - ARRAY PARAMETER
31// SET'S THE EMBED
32HDN.SetEmbed([
33    {
34        color: 11730954,
35        title: 'title',
36        description: 'WOW COOL',
37        fields: [
38            {
39              name: 'field 1',
40              value: 'value',
41            }
42        ]
43    }
44])
45
46// ------------------------------------------ //
47
48// RETURNS VOID
49// PARAMETERS REQUIRED - STRING PARAMETER
50// SET'S THE WEBHOOK AVATAR IMAGE
51// DEFAULT'S TO THE AVATAR IMAGE SET WITHIN DISCORD!
52HDN.SetImage("/Path/To/Image OR https://MyImage.com/cookie.png")
53
54// ------------------------------------------ //
55
56// RETURNS VOID
57// PARAMETERS REQUIRED - OBJECT PARAMETER
58// SET'S THE ALLOWED_MENTIONS
59HDN.SetMentions({
60    parse: ['users', 'roles']
61})
62
63// ------------------------------------------ //
64
65// RETURNS VOID
66// NO PARAMEMTERS REQUIRED
67// STARTS THE REQUEST
68HDN.Request_Post();
69
70// ------------------------------------------ //
71
72// END OF SCRIPT //

Note

Thank you for reading this.

Also to the npm user's don't mind the random keyword's.