telegraf-ts/typings/router.d.ts

Well-Typed fork of telegraf

/** @format */

import { MiddlewareObj, Middleware, MiddlewareFn } from './composer'
import { TelegrafContext } from './context'

type TRoute = string
type MaybePromise<T> = T | Promise<T>

export type RouteFn<TContext extends TelegrafContext> = (
  ctx: TContext
) => MaybePromise<{
  route?: TRoute
} | null>

type HandlersMap<TContext extends TelegrafContext> = Map<
  TRoute,
  Middleware<TContext>
>

export class Router<TContext extends TelegrafContext>
  implements MiddlewareObj<TContext> {
  routeFn: RouteFn<TContext>
  handlers: HandlersMap<TContext>
  otherwiseHandler: Middleware<TContext>

  constructor(routeFn: RouteFn<TContext>, handlers?: HandlersMap<TContext>)

  on(
    route: TRoute,
    fn: Middleware<TContext>,
    ...fns: Middleware<TContext>[]
  ): this

  otherwise(fn: Middleware<TContext>, ...fns: Middleware<TContext>[]): this

  middleware(): MiddlewareFn<TContext>
}