# telegraf-session-sequelize

> Sequelize session middleware for Telegraf

Latest version **1.0.2** (published 2022-05-13) · ISC license · 0 weekly downloads

## Install

```sh
npm install telegraf-session-sequelize
pnpm add telegraf-session-sequelize
yarn add telegraf-session-sequelize
bun add telegraf-session-sequelize
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2022-05-13 |
| First published | 2022-05-13 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 11 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Steshenko Andrey |
| Maintainers | oranjevo |
| Keywords | telegraf, postgres, sequelize, telegraf-session, telegram, middleware, bot |

## Links

- npm: https://www.npmjs.com/package/telegraf-session-sequelize
- Repository: https://github.com/oranjevo/telegraf-session-sequelize
- Homepage: https://github.com/oranjevo/telegraf-session-sequelize#readme
- Issues: https://github.com/oranjevo/telegraf-session-sequelize/issues
- npm.io page: https://npm.io/package/telegraf-session-sequelize

## Dependencies (1)

- [sequelize](https://npm.io/package/sequelize.md) ^6.19.0

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.0.2 (latest) — 2022-05-13
- 1.0.1 — 2022-05-13

## README

# Sequelize session middleware for Telegraf

Sequelize powered simple session middleware for [Telegraf 4.0](https://github.com/telegraf/telegraf) with TypeScript support.

## Installation

```js
$ npm install telegraf-session-sequelize
```

```js
$ yarn add telegraf-session-sequelize
```

## Example

```js
import { Telegraf } from 'telegraf'
import { Sequelize } from 'sequelize'
import { session } from 'telegraf-session-sequelize'

const bot = new Telegraf(process.env.BOT_TOKEN)

const init = async () => {
    const sequelize = await new Sequelize('dbName', 'username', 'pass', {
	    host: 'host',
	    dialect: 'postgres'
    })
	
    bot.use(session(sequelize, { collectionName: 'Sessions' }))
    bot.launch()
}

init()
```

## API

### Options

* `collectionName`: name for MongoDB collection (default: `Sessions`)
* `sessionName`: context property name (default: `session`)
* `sessionKeyFn`: function that generates the session key from the context ([default implementation](https://github.com/alexnzarov/telegraf-session-mongodb/blob/master/src/keys.ts#L10-L16), [legacy deprecated function](https://github.com/alexnzarov/telegraf-session-mongodb/blob/master/src/keys.ts#L21-L31))

---
_Source: https://npm.io/package/telegraf-session-sequelize · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._