Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/toanbku/send-discord-webhook
https://github.com/toanbku/send-discord-webhook
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/toanbku/send-discord-webhook
- Owner: toanbku
- License: mit
- Created: 2024-12-14T10:14:23.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2024-12-14T10:45:31.000Z (about 1 month ago)
- Last Synced: 2024-12-14T11:21:14.950Z (about 1 month ago)
- Language: JavaScript
- Size: 118 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Send Discord Webhook
Lightweight support for sending Discord webhooks without remembering syntax
## Installation
Using npm:
```bash
npm install send-discord-webhook
```
Using yarn
```bash
yarn add send-discord-webhook
```
## Usage
```js
import { sendDiscordWebhook } from "send-discord-webhook";
await sendDiscordWebhook({
url: process.env.DISCORD_WEBHOOK_URL,
title: "🚨 Emergency Alert",
description: `You're sending a Discord webhook without remembering any syntax`,
fields: [
{
name: "Hello",
value: "World",
},
{
name: "packageName",
value: "send-discord-webhook",
},
],
});
```
Result:
## API
### `sendDiscordWebhook(options: DiscordWebhookOptions): Promise`
Sends a Discord webhook with the provided options.
#### Parameters
- `options` (DiscordWebhookOptions): An object containing the following properties:
- `url` (string, required): The URL of the Discord webhook.
- `title` (string, required): The title of the webhook message.
- `description` (string, required): The description of the webhook message.
- `fields` (DiscordWebhookField[], required): An array of fields to include in the webhook message. Each field is an object with `name` and `value` properties.
- `color` (number, optional): The color of the webhook message. Defaults to red (0xff0000) if not provided.
#### Returns
A Promise that resolves to a boolean indicating whether the webhook was sent successfully.
#### Throws
Throws an error if the webhook URL is not provided.
## Types
### `DiscordWebhookField`
Represents a field in the Discord webhook message.
- `name` (string): The name of the field.
- `value` (string): The value of the field.
### `DiscordWebhookOptions`
Represents the options for sending a Discord webhook.
- `url` (string): The URL of the Discord webhook.
- `title` (string): The title of the webhook message.
- `description` (string): The description of the webhook message.
- `fields` (DiscordWebhookField[]): An array of fields to include in the webhook message.
- `color` (number, optional): The color of the webhook message.