Class SceneContext<S>

constructor

• new SceneContext<S extends Record<string, unknown>>(
      options: ISceneContextOptions,
  ): SceneContext<S>

  Type Parameters

  • S extends Record<string, unknown>

  Parameters

  • options: ISceneContextOptions

  Returns SceneContext<S>

canceled

ctx.scene.leave({
  canceled: true
});
Copy

lastAction

leaving

session

ctx.scene.session.moduleFlag = true;
Copy

state

ctx.scene.username = myInputText;
Copy

current

• get current(): undefined | IScene<Record<string, any>>

  Returns current scene

  Returns undefined | IScene<Record<string, any>>

enter

• enter(slug: string, options?: ISceneContextEnterOptions<S>): Promise<void>

  Enter to scene

  ctx.scene.enter('signup');
  ctx.scene.enter('signup', {
    silent: true,
    state: {
      username: 'Super_Developer'
    }
  });
  Copy

  Parameters

  • slug: string
  • options: ISceneContextEnterOptions<S> = {}

  Returns Promise<void>

leave

• leave(options?: ISceneContextLeaveOptions): Promise<void>

  Leave from current scene

  ctx.scene.leave();
  ctx.scene.leave({
    silent: true,
    canceled: true
  });
  Copy

  Parameters

  • options: ISceneContextLeaveOptions = {}

  Returns Promise<void>

reenter

• reenter(): Promise<void>

  Reenter to current scene

  ctx.scene.reenter();
  Copy

  Returns Promise<void>

reset

• reset(): void

  Reset state/session

  Returns void