Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sefinek/is-discord-invite
Verifies the presence of a Discord server invitation within a given string or message, offering robust validation and control mechanisms to ensure the authenticity and validity of the invitation link.
https://github.com/sefinek/is-discord-invite
check discord discord-bot guild invitation invitations invite is is-discord-invite javascript nodejs server
Last synced: 16 days ago
JSON representation
Verifies the presence of a Discord server invitation within a given string or message, offering robust validation and control mechanisms to ensure the authenticity and validity of the invitation link.
- Host: GitHub
- URL: https://github.com/sefinek/is-discord-invite
- Owner: sefinek
- License: mit
- Created: 2022-05-07T01:39:56.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-19T08:53:30.000Z (about 1 month ago)
- Last Synced: 2024-11-27T09:41:37.317Z (26 days ago)
- Topics: check, discord, discord-bot, guild, invitation, invitations, invite, is, is-discord-invite, javascript, nodejs, server
- Language: JavaScript
- Homepage: https://npmjs.com/package/is-discord-invite
- Size: 540 KB
- Stars: 4
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
Is this an invitation to a Discord server? โ
This module checks whether a string is a Discord server invitation.
If it is, it fetches information from the API to find out more about the server.
An alternative (but inferior) method is validating the string solely through regex.
## ๐ฅ ยป Installation
```bash
npm install is-discord-invite
```## โจ Example bot made in Discord.js
> https://github.com/sefinek/is-discord-invitation-bot## ๐ค ยป Table
| Function | Async/await | Options | Validation | Faster? | Reliability | Recommended |
|----------|:------------|-----------------|:-------------------------------------------|---------|-------------|:------------|
| online | Yes | [View](#online) | [API](https://discord.com/api/v10/invites) | โ | โ | โ |
| regex | No | [View](#regex) | [Regex](grex.md) | โ | โ | โ |## ๐ API
### `online(message)`
Checks for valid Discord invitation links in the provided text and fetches invitation data.- `message` (string): The input text to search for Discord invitation links.
> **Returns** ([object](#invitation-data)): A Promise that resolves to an object with invitation data.
### Invitation Data
If a valid invitation link is found, the returned data will have the following structure:```json
{
"success": true,
"code": 200,
"isInvitation": true,
"message": "Success",
"url": {
"full": "https://discord.gg/crtm7UKz",
"invitationCode": "crtm7UKz",
"fetched": "crtm7UKz"
},
"inviter": {
"id": "614087461227986965",
"username": "sefinek025",
"avatar": "a_fc3d7404ae62d64ca4c3d777815ba167",
"discriminator": "0",
"public_flags": 256,
"premium_type": 2,
"flags": 256,
"banner": "a_d9d11fb5320ce4cca30b7d85c837ce64",
"accent_color": null,
"global_name": "Sefinek ๐ ",
"avatar_decoration_data": {
"asset": "a_88f42fb7360d8224a670a50c3496f315",
"sku_id": "1174460780842856588"
},
"banner_color": null
},
"guild": {
"id": "1002327795344621669",
"name": "Pomoc IT - Sefinek",
"splash": null,
"banner": null,
"description": null,
"icon": "faf0e64797c69de5e14be94603935cd9",
"features": [ "COMMUNITY", "CHANNEL_ICON_EMOJIS_GENERATED", "NEWS" ],
"verification_level": 3,
"vanity_url_code": null,
"nsfw_level": 0,
"nsfw": false,
"premium_subscription_count": 0
}
}
```In case the invitation was not valid 100%:
```json
{
"success": true,
"code": null,
"isInvitation": false,
"message": "No valid links found",
"url": null,
"inviter": null,
"guild": null
}
```### `regex(message, { options })`
Checks if the given string contains Discord server invitations. Validation is based solely on the string itself.
In this case, the script does NOT verify whether the link is actually associated with a server.- `message` (string): The input string to be checked.
- `options` (object, optional): An options object for customizing the behavior. You can customize which types of Discord server invitation links to check by setting specific options to `true` or `false`. Available options include:
- `defaultDiscordUrls` (boolean, default `false`): Check default Discord invitation URLs.
- `otherDiscordUrls` (boolean, default `false`): Checks other domains created by Discord Inc. that redirect to discord.com/*.
- `disboard` (boolean, default `false`): Checks URL addresses associated with the **disboard.org** website.
- `discordMe` (boolean, default `false`): Checks URL addresses associated with the **discord.me** website.
- `discordhome` (boolean, default `false`): Checks URL addresses associated with the **discordhome.com** website.If no options are provided, the `everything` option will be set to `true`, meaning that all types of Discord server invitation links will be checked.
> **Returns** (boolean): `true` if the input is a valid Discord server invitation link, `false` otherwise.
## ๐ ยป Examples
### ๐งช Online
In this case, `isInvitation` will be `true` due to the link with the code `HjEyuee4mc`, as it is the only valid one.```js
const IsInvitation = require('is-discord-invite');(async () => {
const result = await IsInvitation.online(
'Lorem ipsum dolor sit amet, https://discord.gg/notValid consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna https://discord.gg/HjEyuee4mc aliqua.",
);console.log(result.isInvitation); // true
})();
```
If the regex detects any invitation, the script sends a [POST request](https://en.wikipedia.org/wiki/POST_(HTTP)) to the [API](https://en.wikipedia.org/wiki/API) to verify the link's validity.### ๐ก Regex
Quick method, but definitely not recommended for most cases. `isInvitation` will be `true` even if the invitation has expired or simply doesn't work.```js
const IsInvitation = require('is-discord-invite');const result1 = IsInvitation.regex('https://discord.gg/HjEyuee4mc', { everything: true }); // Example with `everything` option
console.log(result1); // trueconst result2 = IsInvitation.regex('https://discord.gg/notVaildUrl');
console.log(result2); // trueconst result3 = IsInvitation.regex('https://example.com/bKzhAdd6Fa');
console.log(result3); // false
```## ๐ค ยป Help
If you have any questions or just need help, please visit my [official website](https://sefinek.net), where you can find my email and my current Discord username. Feel free to send me a message on Discord or reach out via email.> Alternatively, you can create a new [Issue](https://github.com/sefinek/is-discord-invite/issues/new).
## ๐ฟ Pull requests
Collaborators are welcome! If you'd like to contribute your suggestions or corrections to this project, we encourage you to create [Pull requests](https://github.com/sefinek/is-discord-invite/pulls).## โญ ยป Thanks
Thank you for your interest in this module. If you like it or find it useful, please consider starring the [repository](https://github.com/sefinek/is-discord-invite).