Redis session middleware for Telegraf

Redis powered session middleware for Telegraf.

Installation

1$ npm install telegraf-session-redis

Example

1const Telegraf = require('telegraf')
2const RedisSession = require('telegraf-session-redis')
3
4const bot = new Telegraf(process.env.BOT_TOKEN)
5
6const session = new RedisSession({
7  store: {
8    host: process.env.TELEGRAM_SESSION_HOST || '127.0.0.1',
9    port: process.env.TELEGRAM_SESSION_PORT || 6379
10  }
11})
12
13bot.use(session)
14
15bot.on('text', (ctx) => {
16  ctx.session.counter = ctx.session.counter || 0
17  ctx.session.counter++
18  console.log('Session', ctx.session)
19})
20
21bot.launch()

When you have stored the session key beforehand, you can access a session without having access to a context object. This is useful when you perform OAUTH or something similar, when a REDIRECT_URI is called on your bot server.

1const redisSession = new RedisSession()
2
3// Retrieve session state by session key
4redisSession.getSession(key)
5  .then((session) => {
6    console.log('Session state', session)
7  })
8
9// Save session state
10redisSession.saveSession(key, session)

API

Options

• store:
  • host: Redis host (default: 127.0.0.1)
  • port: Redis port (default: 6379)
  • path: Unix socket string
  • url: Redis url
  • ...: Other redis connection options
• property: context property name (default: session)
• ttl: session ttl in seconds (default: forever)
• getSessionKey: session key resolver function (ctx) => any)

Default implementation of getSessionKey:

1function getSessionKey (ctx) {
2  if (!ctx.from || !ctx.chat) {
3    return
4  }
5  return `${ctx.from.id}:${ctx.chat.id}`
6}

Destroying a session

To destroy a session simply set it to null.

1bot.on('text', (ctx) => {
2  ctx.session = null
3})
4