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

@botol/tg-bot

v0.0.4

Published

## Simple Examples ```typescript import { BotolTg } from '@botol/tg-bot';

Downloads

6

Readme

Botol Telegram Bot

Simple Examples

import { BotolTg } from '@botol/tg-bot';

let bot = new BotolTg('<token>');
bot.on('text', (ctx, next) => {
    ctx.reply('Hello ' + ctx.text);
});
bot.use((ctx, next) => {
    ctx.reply('Enter name');
});
bot.startPolling();

Middlewares

| Name | Description | |---|---| | Session | Adding session to Context | | Threads | Make bot multithreaded |

Events

Pass as first param in on

| Name | Description | |---|---| | 'message' | Call when update has param message | | 'callback_query' | Call when update has param callback_query | | 'text' | Call when update has param message.text | | 'callback_data' | Call when update has param callback_query.data |

Context

| Property | Description | |---|---| | telegram | TgClient instance with methods | | update | Received update | | message | (Optional) Message from update | | callback_query | (Optional) CallbackQuery from update | | chat | (Optional) Chat from update | | text | (Optional) Extracted from message | | callbackData | (Optional) Extracted from callback_query | | chat | (Optional) Extracted from one of several params | | from | (Optional) Extracted from one of several params |

| Method | Arguments | Type | Description | |---|---|---|---| | reply ||| Throw error if the chat property don't exists | || text | string | Text to send | || markup | Markup or ExtraMarkup | (Optional) Extra markup like keyboard or disable preview | | answerCbQuery ||| Throw error if the callback_query property don't exists | || text | string | (Optional) Text to send | || showAlert | boolean | (Optional) Show alert |

Markup

  • keyboard
        Markup.keyboard(['Option 1', 'Option 2'])
  • inline keyboard
        Markup.inlineKeyboard([
            { text: 'Option 1', callback_data: 'Option1' },
            { text: 'Option 2', callback_data: 'Option2' }
        ])

Examples

Create Middleware

type ContextSystem = {
    getPoints: () => number;
    addPoint: (sum: number) => void;
};
function BotSystem(): Handler<Partial<ContextSystem> & ContextTG> {
    let points = 0;
    return (ctx, next) => {
        ctx.addPoint = (sum) => {
            points += sum;
        };
        ctx.getPoints = () => points;

        return next();
    };
}

Use Middleware

let bot = new BotolTg('<token>');
let botSystem = bot.middleware(BotSystem());

botSystem.on('callback_data', (ctx, next) => {
    switch (ctx.callbackData) {
        case 'show':
            ctx.answerCbQuery(ctx.getPoints().toString());
            return;
        case 'add':
            ctx.addPoint(1);
            ctx.answerCbQuery();
            return;
        case 'sub':
            ctx.addPoint(-1);
            ctx.answerCbQuery();
            return;
    }
    ctx.answerCbQuery();
    return next();
});
botSystem.use((ctx) => {
    ctx.reply(
        `current points: ${ctx.getPoints()}`,
        Markup.inlineKeyboard([
            [
                { text: 'add', callback_data: 'add' },
                { text: 'sub', callback_data: 'sub' },
            ],
            [{ text: 'show', callback_data: 'show' }],
        ]),
    );
});
bot.startPolling();