npm.io
0.5.1 • Published 8 years ago

messenja

Licence
MIT
Version
0.5.1
Deps
5
Size
8 kB
Vulns
25
Weekly
0

Messenja

Messenja est un framework NodeJS qui facilite la création de bots Telegram.

Pré-requis

  • Un serveur avec une URL en https accessible depuis le Web pour la communication avec l'API de Telegram
  • Un token de bot Telegram Voir ici avec une adresse de webhook configurée sur l'URL de votre serveur
  • Une base de données Redis pour stocker des données entre les requêtes

Installation

Messenja est disponible dans les dépôts NPM:

npm intall --save messenja

Quick-start

// index.js
const {Messenja} = require('messenja');

Messenja({request, response} => {
   const {first_name} = this.user;
   response.sendMessage(`Salut ${first_name} !`);
});

Avant de lancer votre bot, il est nécessaire de lui fournir des variables d'environnements:

export TELEGRAM_TOKEN=<token>
export REDIS_URL=redis
node index

API

Messenja

La fonction fourni à Messenja obtient trois arguments en retour (callback):

  • request - Instance de Request pour l'utilisateur courant
  • response - Instance de Response pour l'utilisateur courant
  • storage - Utilitaire pour utiliser la base de données dans le contexte de l'utilisateur courant
  • data - Ensemble des données de la base concernant l'utilisateur courant

Keywords