notify-utils v1.0.1

Notify

Table of Contents

1. Overview
2. How To Install
3. 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.

How To Install

To install the notify module, follow these steps:

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:

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:

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:

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.