npm

Need private packages and team management tools?Check out npm Orgs. »

system-notifier

1.0.1 • Public • Published

system-notifier Build Status Coverage Status

System notifier sending Telegram message and SMS.

Installation

npm install system-notifier

Usage

const SystemNotifier = require('system-notifier');
/** Or with ES6+ */
import SystemNotifier from 'system-notifier';
 
const notifier = new SystemNotifier({
  prefix: 'domain.com',
  telegram: {
    botToken: process.env.TELEGRAM_BOT_TOKEN,
    chatId: process.env.TELEGRAM_CHAT_ID
  },
  twilio: {
    authToken: process.env.TWILIO_AUTH_TOKEN,
    accountSID: process.env.TWILIO_ACCOUNT_SID,
    fromNumber: process.env.TWILIO_FROM_NUMBER,
    toNumber: process.env.TWILIO_TO_NUMBER
  }
})

Then, call notifier.notify function with your message:

notifier.notify('Internal Server Error...');

You can add an emoji prefix with one of the following codes: info (ℹ️), error (❌), warning (⚠️) or success (✅).

notifier.notify('Internal Server Error...', 'error');

Build

npm run build

Testing

Create a .env file and add your providers credentials:

TELEGRAM_BOT_TOKEN=
TELEGRAM_CHAT_ID=
TWILIO_AUTH_TOKEN=
TWILIO_ACCOUNT_SID=
TWILIO_FROM_NUMBER=
TWILIO_TO_NUMBER=
npm test

Related

License

This project is licensed under the MIT license.

Keywords

none

install

npm i system-notifier

Downloadsweekly downloads

8

version

1.0.1

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability