Guard middlewares for grammY

Introduction

A library that simplifies the creation of guard middlewares and contains a set of predefined filters that are often used.

Installation

npm install grammy-guard

or using yarn:

yarn add grammy-guard

Example

import { Bot } from "grammy";
import { guard, reply, not, isAdmin, isPrivate } from "grammy-guard";

const bot = new Bot(process.env.BOT_TOKEN as string);

bot.command(
  "private",
  guard(isPrivate, reply("/private is only available in private chats!")),
  (ctx) => ctx.reply("Hello in private!");
);

bot.command(
  "admin",
  guard(
    [not(isPrivate), isAdmin],
    reply("/admin is only available to administrators in non-private chats!")
  ),
  (ctx) => ctx.reply("Hello, chat admin!");
);

bot.start();

There’s some more examples:

Reference

Filter	Description
`isPrivate`	Checks if it is a private chat
`isBasicGroup`	Checks if it is a basic group chat
`isSupergroup`	Checks if it is a supergroup chat
`isGroup`	Checks if it is a basic group or a supergroup chat
`isChannel`	Checks if it is a channel
`isUser`	Checks if the user is not a bot
`isBot`	Checks if the user is a bot
`isUserId(id: number)`	Checks if the user has this ID
`isUserFromReply`	Checks if the user is the same user who sent the message to which the bot replied. It is useful that only the user who called up the menu can use the callback buttons.
`isAdmin`	Checks if the user is an admin

Feel free to contribute!