npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

telejs-framework

v1.0.3

Published

TeleJS is a framework built in top of node-telegram-bot-api to help you build telegram bots more flexible and powerful.

Downloads

13

Readme

TeleJS

TeleJS is a framework built in top of node-telegram-bot-api to help you build telegram bots more flexible and powerful.

TeleJS is pretty new, expect bugs!

@TeleJS Alpha v1.0.0

Guide

Creating a client for our bot

const { TeleClient } = require("telejs-framework");

const client = new TeleClient("token", {
  owners: ["owner_id"], // not required
});

Creating a command handler

const { TeleClient, CommandHandler } = require("telejs-framework");

const client = new TeleClient("token", {
  owners: ["owner_id"], // not required
});

const commandHandler = new CommandHandler(client, {
  prefix: "!", // default is / which used by telegram but telejs handles others too!
  directory: "./commands",
});
commandHandler.loadCommands();

Creating a command
Command files must be inside the directory path specified inside CommandHandler options.

const { Command } = require("telejs-framework");

class Ping extends Command {
  constructor() {
    super({
      name: "ping", // Command name
      aliases: ["p"], // Other ways to call the command (aka aliases)
      description: "Ping pong command", // Command description
      category: "general", // Command categorizing to help with organization
    });
  }

  async execute(message) {
    return this.client.sendMessage(message.chat.id, "Pong!");
  }
}

module.exports = Ping;

Creating a listener handler

const {
  TeleClient,
  CommandHandler,
  ListenerHandler,
} = require("telejs-framework");

const client = new TeleClient("token", {
  owners: ["owner_id"], // not required
});

const commandHandler = new CommandHandler(client, {
  prefix: "!", // default is / which used by telegram but telejs handles others too!
  directory: "./commands",
});
const listenerHandler = new ListenerHandler(client, {
  directory: "./listeners",
});
listenerHandler.setEmitters({
  commandHandler,
}); // by setting emitters, you can handle events emitted outside of the TeleClient!
listenerHandler.loadListeners(); // You have to load listeners before command handler so you can handle load event emitted by CommandHandler when a command loaded!
commandHandler.loadCommands();

Creating a listener
Listener files must be inside the directory path specified inside ListenerHandler options.

const { Listener } = require("telejs-framework");

class MessageListener extends Listener {
  constructor() {
    super({
      name: "message", // listener name NOT THE EVENT TO LISTEN FOR.
      event: "message", // event to listen for
      emitter: "client", // emitter to listen at (client is loaded by default!)
      once: false,
    });
  }

  async execute(message) {
    console.log(message);
  }
}

module.exports = MessageListener;

More detailed guide and docs will be available soon!

Contact

Github repo is coming with the next update!
Discord Server
Telegram