Skip to content

@gramio/scenes

npmJSRJSR Score

WIP. The API can be changed, but we already use it in production environment.

Usage

ts
import { 
Bot
} from "gramio";
import {
scenes
,
Scene
} from "@gramio/scenes";
const
testScene
= new
Scene
("test")
.
params
<{
test
: boolean }>()
.
step
("message", async (
context
) => {
if (
context
.
scene
.
step
.
firstTime
||
context
.
text
!== "1")
return
context
.
send
("1");
if (
context
.
scene
.
params
.
test
=== true) await
context
.
send
("DEBUG!");
return
context
.
scene
.
step
.
next
();
}); const
bot
= new
Bot
(
process
.
env
.
TOKEN
as string)
.
extend
(
scenes
([
testScene
]))
.
command
("start", async (
context
) => {
return
context
.
scene
.
enter
(
testScene
, {
test
: true,
}); });

Share state between steps

ts
import { 
Scene
} from "@gramio/scenes";
const
testScene
= new
Scene
("test")
.
step
("message", async (
context
) => {
if (
context
.
scene
.
step
.
firstTime
||
context
.
text
!== "1")
return
context
.
send
("1");
return
context
.
scene
.
update
({
messageId
:
context
.
id
,
some
: "hii!" as
const
,
}); }) .
step
("message", async (
context
) => {
if (
context
.
scene
.
step
.
firstTime
||
context
.
text
!== "2")
return
context
.
send
("2");
console
.
log
(
context
.
scene
.
state
.
messageId
);
});

Storage usage

ts
import { redisStorage } from "@gramio/storage-redis";

const bot = new Bot(process.env.TOKEN as string)
    .extend(
        scenes([testScene], {
            storage: redisStorage(),
        })
    )
    .command("start", async (context) => {
        return context.scene.enter(someScene, {
            test: true,
        });
    });