Class BaseHandler<C, R>`Abstract`

Abstract base class for all update handlers.

Type Parameters

C extends CallbackContext = CallbackContext
Type of the callback context.
R = unknown
Return value type.

Index

Constructors

Properties

Methods

checkUpdate handleUpdate

Constructors

constructor

new BaseHandler<
    C extends
        CallbackContext<
            Record<string, unknown>,
            Record<string, unknown>,
            Record<string, unknown>,
        > = CallbackContext<
        Record<string, unknown>,
        Record<string, unknown>,
        Record<string, unknown>,
    >,
    R = unknown,
>(
    callback: HandlerCallback<C, R>,
): BaseHandler<C, R>
Creates a new handler instance.
Type Parameters
- C extends CallbackContext<
      Record<string, unknown>,
      Record<string, unknown>,
      Record<string, unknown>,
  > = CallbackContext<
      Record<string, unknown>,
      Record<string, unknown>,
      Record<string, unknown>,
  >
  Type of the callback context.
- R = unknown
  Return value type.
Parameters
- callback: HandlerCallback<C, R>
  Async function executed when this handler matches an update.
Returns BaseHandler<C, R>

Properties

`Protected`callback

callback: HandlerCallback<C, R>

The underlying callback function to invoke on match.

Methods

`Abstract`checkUpdate

checkUpdate(update: Update): boolean | Promise<boolean>
Checks if the incoming update should be handled by this handler.
Parameters
- update: Update
  The Telegram update to process.
Returns boolean | Promise<boolean>
true if it matches, false otherwise.

handleUpdate

handleUpdate(update: Update, context: C): Promise<R>
Executes the registered handler callback with the given update and context.
Parameters
- update: Update
  The Telegram update to process.
- context: C
  Callback context instance.
Returns Promise<R>
The value returned by the callback function.