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

telegraf-mysql2-session

v1.0.0

Published

MySQL session management middleware for Telegraf.js bots.

Downloads

1

Readme

Telegraf MySQL Session Module

Telegraf MySQL Session Module is a robust session management middleware for Telegraf.js bots that seamlessly integrates with MySQL databases. This comprehensive README provides detailed instructions on installation, usage, API documentation, error handling, and licensing information.

Table of Contents

Installation

To install the Telegraf MySQL Session Module, use npm:

npm install telegraf-mysql2-session

Usage

Integrate the Telegraf MySQL Session Module into your Telegraf bot with the following steps:

  1. Require the module and initialize MySQLSession:
const { Telegraf } = require('telegraf');
const MySQLSession = require('telegraf-mysql2-session');

const session = new MySQLSession({
  host: 'localhost',
  user: 'root',
  password: 'root',
  database: 'sessions',
});
  1. Add the middleware to your Telegraf bot:
const bot = new Telegraf('shhh... secret');
bot.use(session.middleware());
  1. Access and modify session data using ctx.session:
bot.on('text', (ctx) => {
  // Set session value
  ctx.session.counter = (ctx.session.counter || 0) + 1;
  // Get session value
  ctx.reply(`Counter: ${ctx.session.counter}`);
});

bot.launch();

For detailed API documentation and advanced usage, refer to the API section below.

API

Constructor

Create a new instance of MySQLSession with the following options:

new MySQLSession(options)
  • options: An object containing MySQL connection options and session configuration.

Options

  • host: MySQL server host (default: 'localhost').
  • user: MySQL user (default: 'root').
  • password: MySQL password (default: null).
  • database: MySQL database name (default: 'telegraf_sessions').
  • connectionLimit: Maximum number of connections in the pool (default: 10).
  • cleanupInterval: Interval (in milliseconds) for cleaning up expired sessions (default: 3600000).
  • sessionsTableName: Name of the table to store sessions (default: 'bejiihiu_sessions').

Methods

saveSession(sessionId, sessionData, expirationTime)

Save session data to the database.

  • sessionId: Unique identifier for the session.
  • sessionData: Data to be stored in the session.
  • expirationTime: Expiration time for the session data in seconds (default: 3600).

getSession(sessionId)

Retrieve session data from the database.

  • sessionId: Unique identifier for the session.

Middleware

Generate Telegraf middleware function for session management.

session.middleware()

Error Handling

Errors during session creation, cleanup, or database queries are logged to the console. Customize error handling logic as needed.

License

This project is licensed under the MIT License. See the LICENSE file for details.