https://github.com/dev-diaries41/notify
A flexible class for sending notifications via telegram and discord
https://github.com/dev-diaries41/notify
discord notifications telegram
Last synced: 5 months ago
JSON representation
A flexible class for sending notifications via telegram and discord
- Host: GitHub
- URL: https://github.com/dev-diaries41/notify
- Owner: dev-diaries41
- Created: 2024-01-22T21:30:20.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-03T19:06:48.000Z (over 1 year ago)
- Last Synced: 2025-10-29T00:42:19.597Z (8 months ago)
- Topics: discord, notifications, telegram
- Language: TypeScript
- Homepage:
- Size: 11.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Notify
## Table of Contents
1. [Overview](#overview)
2. [How To Install](#how-to-install)
3. [How To Use](#how-to-use)
## Introduction
The `notify` module is a notification utility that allows you to send messages via Telegram and Discord. It provides a simple API for broadcasting messages to multiple recipients on these platforms.
To install the `notify` module, follow these steps:
```bash
npm install notify-utils
```
## How To Use
You can get your Telegram bot token from the `Bot Father` Telegram channel. You can get your Discord webhook URL from within Discord.
### Examples
Example of sending a Telegram notification:
```typescript
import { Notify } from 'notify-utils';
// Your Telegram bot token from Bot Father
const config = {
telegramConfig: {
token: 'YOUR_TELEGRAM_BOT_TOKEN'
}
};
// Initialize Notify instance
const notify = new Notify(config);
// Send a message
const chatId = 'TELEGRAM_CHAT_ID'; // Replace with the actual chat ID. For channels and groups the channel and group name can be used e.g @my_channel
const message = 'Hello, this is a test message for Telegram!';
notify.telegram(chatId, message)
.then(response => {
console.log(response);
})
.catch(error => {
console.error(error);
});
```
Example of sending a Discord notification:
```typescript
import { Notify } from 'notify-utils';
// Your Telegram bot token from Bot Father
const config = {
telegramConfig: {
token: 'YOUR_TELEGRAM_BOT_TOKEN'
}
};
// Initialize Notify instance (the telegram config is still needed because Notify extends TelegramBot class)
const notify = new Notify(config);
// Send a message
const webhookUrl = 'YOUR_DISCORD_WEBHOOK_URL'; // Replace with the actual webhook URL
const message = 'Hello, this is a test message for Discord!';
notify.discord(webhookUrl, message)
.then(response => {
console.log(response);
})
.catch(error => {
console.error(error);
});
```
Example of sending a broadcast notification:
```typescript
import { Notify } from 'notify-utils';
// Your Telegram bot token from Bot Father
const config = {
telegramConfig: {
token: 'YOUR_TELEGRAM_BOT_TOKEN'
}
};
// Initialize Notify instance
const notify = new Notify(telegramConfig);
// Define recipients
const recipients = [
{ telegramChatId: 'TELEGRAM_CHAT_ID_1' },
{ discordWebhookUrl: 'DISCORD_WEBHOOK_URL_1' }
// Add more recipients as needed
];
// Message to be broadcasted
const message = 'Hello, this is a broadcast message!';
// Send broadcast message
notify.broadcast(recipients, message)
.then(response => {
console.log(response);
})
.catch(error => {
console.error(error);
});
```
### Notes:
- Replace `'YOUR_TELEGRAM_BOT_TOKEN'`, `'TELEGRAM_CHAT_ID'`, and `'YOUR_DISCORD_WEBHOOK_URL'` with your actual credentials.
This documentation provides a basic overview and usage examples for the `Notify` class, making it easier for users to integrate and use it in their projects.