Grammy-middlewares NPM

Set of useful middlewares for grammY

Feel free to contribute your middlewares to this repository.

Installation

yarn add grammy-middlewares, duh.

Usage

All the middleware accessors are factories, even though not all of them have to be. I decided to make API homogeneous.

Some of the factories consume optional or required parameters.

import {
  ignoreOld,
  onlyAdmin,
  onlyPublic,
  onlySuperAdmin,
  sequentialize,
} from 'grammy-middlewares'

<...>

bot.use(
  ignoreOld(),
  onlyAdmin(ctx => ctx.reply(
    'Only admins can do this'
  )),
  onlyPublic(ctx => ctx.reply(
    'You can only use public chats'
  )),
  onlySuperAdmin(env.SUPER_ADMIN_ID),
  sequentialize()
)

<...>

menu.text(
  'Only menu creator',
  onlyMenuAuthor(ctx =>
    ctx.reply('Only menu creator can do this')
  ),
  ctx => ...
)

Middlewares

`ignoreOld`

Ignores old updates, useful when bot has been down for a while. You can optionaly specify the timeout in seconds which defaults to 5 * 60.

`onlyAdmin`

Checks if the user is an admin. You can optionally specify errorHandler that is called with the context if the user is not an admin.

`onlyPublic`

Checks if it is a group chat or a channel. You can optionally specify errorHandler that is called with the context if it is not a group chat or a channel.