telegraf-session-rethinkdb

RethinkDB session middleware for Telegraf

RethinkDB store-based session middleware for Telegraf (Telegram bot framework).

Installation

$ npm install telegraf-session-rethinkdb

Example

var Telegraf = require('telegraf')
var session = require('telegraf-session-rethinkdb')
 
var telegraf = new Telegraf(process.env.BOT_TOKEN)
 
telegraf.use(session())
 
telegraf.use(function * (){
  this.session.counter = this.session.counter || 0
  this.session.counter++
  console.log('->', this.session)
})
 
telegraf.startPolling()

API

Options

• store:
  • host: RethinkDB host (default: localhost)
  • port: RethinkDB port (default: 28015)
  • ...: Other RethinkDB connection options
• table: table name (default: "_telegraf_session")
• ttl: session ttl in seconds (default: 0)
• getSessionKey: session key function (context -> string)

Default session key depends on sender/chat:

function getSessionKey(ctx) {
  return `${ctx.from.id}:${ctx.chat.id}`
}

Destroying a session

To destroy a session simply set it to null.

this.session = {}

License

The MIT License (MIT)

Copyright (c) 2016 Vitaly Domnikov

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.