Class Composer<C>

Type Parameters

C extends Context

Hierarchy (View Summary)

Composer

Implements

MiddlewareObj<C>

Constructors

constructor

new Composer<C extends Context<Update>>(
...fns: readonly Middleware<C>[],
): Composer<C>
Type Parameters
- C extends Context<Update>
Parameters
- ...fns: readonly Middleware<C>[]
Returns Composer<C>
- Defined in composer.ts:65

Properties

`Static`mount

mount: {
    <
        Ctx extends Context<Update>,
        Filter extends UpdateType | Guard<Ctx["update"]>,
    >(
        filters: MaybeArray<Filter>,
        ...fns: NonemptyReadonlyArray<Middleware<FilteredContext<Ctx, Filter>>>,
    ): MiddlewareFn<Ctx>;
    <
        Ctx extends Context<Update>,
        Filter extends

                | "text"
                | "sticker"
                | "animation"
                | "show_caption_above_media"
                | "audio"
                | "document"
                | "photo"
                | "checklist"
                | "video"
                | "video_note"
                | "voice"
                | "callback_query"
                | "channel_post"
                | "chat_member"
                | "chosen_inline_result"
                | "edited_channel_post"
                | "business_connection"
                | "business_message"
                | "edited_business_message"
                | "deleted_business_messages"
                | "message_reaction"
                | "message_reaction_count"
                | "edited_message"
                | "inline_query"
                | "message"
                | "my_chat_member"
                | "pre_checkout_query"
                | "purchased_paid_media"
                | "poll_answer"
                | "poll"
                | "shipping_query"
                | "chat_join_request"
                | "chat_boost"
                | "removed_chat_boost"
                | "new_chat_members"
                | "left_chat_member"
                | "chat_owner_left"
                | "chat_owner_changed"
                | "new_chat_title"
                | "new_chat_photo"
                | "delete_chat_photo"
                | "group_chat_created"
                | "supergroup_chat_created"
                | "refunded_payment"
                | "channel_chat_created"
                | "message_auto_delete_timer_changed"
                | "migrate_to_chat_id"
                | "migrate_from_chat_id"
                | "pinned_message"
                | "invoice"
                | "successful_payment"
                | "users_shared"
                | "chat_shared"
                | "gift"
                | "unique_gift"
                | "gift_upgrade_sent"
                | "connected_website"
                | "write_access_allowed"
                | "passport_data"
                | "proximity_alert_triggered"
                | "boost_added"
                | "chat_background_set"
                | "checklist_tasks_done"
                | "checklist_tasks_added"
                | "direct_message_price_changed"
                | "forum_topic_created"
                | "forum_topic_edited"
                | "forum_topic_closed"
                | "forum_topic_reopened"
                | "general_forum_topic_hidden"
                | "general_forum_topic_unhidden"
                | "giveaway_created"
                | "giveaway"
                | "giveaway_winners"
                | "giveaway_completed"
                | "paid_message_price_changed"
                | "suggested_post_approved"
                | "suggested_post_approval_failed"
                | "suggested_post_declined"
                | "suggested_post_paid"
                | "suggested_post_refunded"
                | "video_chat_scheduled"
                | "video_chat_started"
                | "video_chat_ended"
                | "video_chat_participants_invited"
                | "web_app_data"
                | "has_media_spoiler"
                | "contact"
                | "dice"
                | "game"
                | "location"
                | "story"
                | "venue"
                | "forward_date",
    >(
        filters: MaybeArray<Filter>,
        ...fns: NonemptyReadonlyArray<
            Middleware<NarrowedContext<Ctx, MountMap[Filter]>, MountMap[Filter]>,
        >,
    ): MiddlewareFn<Ctx>;
} = Composer.on

Generates middleware for handling provided update types.

Type Declaration

- <Ctx extends Context<Update>, Filter extends UpdateType | Guard<Ctx["update"]>>(
  filters: MaybeArray<Filter>,
  ...fns: NonemptyReadonlyArray<Middleware<FilteredContext<Ctx, Filter>>>,
  ): MiddlewareFn<Ctx>
- Generates middleware for handling updates narrowed by update types or filter queries.
  Type Parameters
  - Ctx extends Context<Update>
  - Filter extends UpdateType | Guard<Ctx["update"]>
  Parameters
  - filters: MaybeArray<Filter>
  - ...fns: NonemptyReadonlyArray<Middleware<FilteredContext<Ctx, Filter>>>
  Returns MiddlewareFn<Ctx>
- <
      Ctx extends Context<Update>,
      Filter extends
  
              | "text"
              | "sticker"
              | "animation"
              | "show_caption_above_media"
              | "audio"
              | "document"
              | "photo"
              | "checklist"
              | "video"
              | "video_note"
              | "voice"
              | "callback_query"
              | "channel_post"
              | "chat_member"
              | "chosen_inline_result"
              | "edited_channel_post"
              | "business_connection"
              | "business_message"
              | "edited_business_message"
              | "deleted_business_messages"
              | "message_reaction"
              | "message_reaction_count"
              | "edited_message"
              | "inline_query"
              | "message"
              | "my_chat_member"
              | "pre_checkout_query"
              | "purchased_paid_media"
              | "poll_answer"
              | "poll"
              | "shipping_query"
              | "chat_join_request"
              | "chat_boost"
              | "removed_chat_boost"
              | "new_chat_members"
              | "left_chat_member"
              | "chat_owner_left"
              | "chat_owner_changed"
              | "new_chat_title"
              | "new_chat_photo"
              | "delete_chat_photo"
              | "group_chat_created"
              | "supergroup_chat_created"
              | "refunded_payment"
              | "channel_chat_created"
              | "message_auto_delete_timer_changed"
              | "migrate_to_chat_id"
              | "migrate_from_chat_id"
              | "pinned_message"
              | "invoice"
              | "successful_payment"
              | "users_shared"
              | "chat_shared"
              | "gift"
              | "unique_gift"
              | "gift_upgrade_sent"
              | "connected_website"
              | "write_access_allowed"
              | "passport_data"
              | "proximity_alert_triggered"
              | "boost_added"
              | "chat_background_set"
              | "checklist_tasks_done"
              | "checklist_tasks_added"
              | "direct_message_price_changed"
              | "forum_topic_created"
              | "forum_topic_edited"
              | "forum_topic_closed"
              | "forum_topic_reopened"
              | "general_forum_topic_hidden"
              | "general_forum_topic_unhidden"
              | "giveaway_created"
              | "giveaway"
              | "giveaway_winners"
              | "giveaway_completed"
              | "paid_message_price_changed"
              | "suggested_post_approved"
              | "suggested_post_approval_failed"
              | "suggested_post_declined"
              | "suggested_post_paid"
              | "suggested_post_refunded"
              | "video_chat_scheduled"
              | "video_chat_started"
              | "video_chat_ended"
              | "video_chat_participants_invited"
              | "web_app_data"
              | "has_media_spoiler"
              | "contact"
              | "dice"
              | "game"
              | "location"
              | "story"
              | "venue"
              | "forward_date",
  >(
      filters: MaybeArray<Filter>,
      ...fns: NonemptyReadonlyArray<
          Middleware<NarrowedContext<Ctx, MountMap[Filter]>, MountMap[Filter]>,
      >,
  ): MiddlewareFn<Ctx>
- Generates middleware for handling updates narrowed by update types or message subtype.
  Type Parameters
  - Ctx extends Context<Update>
  - Filter extends
        | "text"
        | "sticker"
        | "animation"
        | "show_caption_above_media"
        | "audio"
        | "document"
        | "photo"
        | "checklist"
        | "video"
        | "video_note"
        | "voice"
        | "callback_query"
        | "channel_post"
        | "chat_member"
        | "chosen_inline_result"
        | "edited_channel_post"
        | "business_connection"
        | "business_message"
        | "edited_business_message"
        | "deleted_business_messages"
        | "message_reaction"
        | "message_reaction_count"
        | "edited_message"
        | "inline_query"
        | "message"
        | "my_chat_member"
        | "pre_checkout_query"
        | "purchased_paid_media"
        | "poll_answer"
        | "poll"
        | "shipping_query"
        | "chat_join_request"
        | "chat_boost"
        | "removed_chat_boost"
        | "new_chat_members"
        | "left_chat_member"
        | "chat_owner_left"
        | "chat_owner_changed"
        | "new_chat_title"
        | "new_chat_photo"
        | "delete_chat_photo"
        | "group_chat_created"
        | "supergroup_chat_created"
        | "refunded_payment"
        | "channel_chat_created"
        | "message_auto_delete_timer_changed"
        | "migrate_to_chat_id"
        | "migrate_from_chat_id"
        | "pinned_message"
        | "invoice"
        | "successful_payment"
        | "users_shared"
        | "chat_shared"
        | "gift"
        | "unique_gift"
        | "gift_upgrade_sent"
        | "connected_website"
        | "write_access_allowed"
        | "passport_data"
        | "proximity_alert_triggered"
        | "boost_added"
        | "chat_background_set"
        | "checklist_tasks_done"
        | "checklist_tasks_added"
        | "direct_message_price_changed"
        | "forum_topic_created"
        | "forum_topic_edited"
        | "forum_topic_closed"
        | "forum_topic_reopened"
        | "general_forum_topic_hidden"
        | "general_forum_topic_unhidden"
        | "giveaway_created"
        | "giveaway"
        | "giveaway_winners"
        | "giveaway_completed"
        | "paid_message_price_changed"
        | "suggested_post_approved"
        | "suggested_post_approval_failed"
        | "suggested_post_declined"
        | "suggested_post_paid"
        | "suggested_post_refunded"
        | "video_chat_scheduled"
        | "video_chat_started"
        | "video_chat_ended"
        | "video_chat_participants_invited"
        | "web_app_data"
        | "has_media_spoiler"
        | "contact"
        | "dice"
        | "game"
        | "location"
        | "story"
        | "venue"
        | "forward_date"
  Parameters
  - filters: MaybeArray<Filter>
  - ...fns: NonemptyReadonlyArray<
    Middleware<NarrowedContext<Ctx, MountMap[Filter]>, MountMap[Filter]>,
    >
  Returns MiddlewareFn<Ctx>
  Deprecated
  Use filter utils instead. Support for Message subtype in Composer.on will be removed in Telegraf v5.

Deprecated

use Composer.on instead

Methods

action

action(
    triggers: Triggers<
        NarrowedContext<C, CallbackQueryUpdate<CallbackQuery>>,
    >,
    ...fns: MatchedMiddleware<C, "callback_query">,
): Composer<C>
Registers middleware for handling matching callback queries.
Parameters
- triggers: Triggers<NarrowedContext<C, CallbackQueryUpdate<CallbackQuery>>>
- ...fns: MatchedMiddleware<C, "callback_query">
Returns Composer<C>
- Defined in composer.ts:151

cashtag

cashtag(cashtag: MaybeArray<string>, ...fns: MatchedMiddleware<C>): Composer<C>
Parameters
- cashtag: MaybeArray<string>
- ...fns: MatchedMiddleware<C>
Returns Composer<C>
- Defined in composer.ts:253

command

command(
    command: Triggers<
        NarrowedContext<
            C,
            { message: New & NonChannel & TextMessage; update_id: number },
        >,
    >,
    ...fns: NonemptyReadonlyArray<
        Middleware<
            Context<
                { message: New & NonChannel & TextMessage; update_id: number },
            > & Omit<C, keyof Context<Update>> & CommandContextExtn,
        >,
    >,
): Composer<C>
Registers middleware for handling specified commands.
Parameters
- command: Triggers<
      NarrowedContext<
          C,
          { message: New & NonChannel & TextMessage; update_id: number },
      >,
  >
- ...fns: NonemptyReadonlyArray<
      Middleware<
          Context<{ message: New & NonChannel & TextMessage; update_id: number }> & Omit<
              C,
              keyof Context<Update>,
          > & CommandContextExtn,
      >,
  >
Returns Composer<C>
- Defined in composer.ts:137

drop

drop(predicate: Predicate<C>): Composer<C>
Registers middleware for dropping matching updates.
Parameters
- predicate: Predicate<C>
Returns Composer<C>
- Defined in composer.ts:201

email

email(email: Triggers<C>, ...fns: MatchedMiddleware<C>): Composer<C>
Parameters
- email: Triggers<C>
- ...fns: MatchedMiddleware<C>
Returns Composer<C>
- Defined in composer.ts:225

filter

filter(predicate: Predicate<C>): Composer<C>
Parameters
- predicate: Predicate<C>
Returns Composer<C>
Deprecated
use Composer::drop
- Defined in composer.ts:206

gameQuery

gameQuery(
    ...fns: NonemptyReadonlyArray<
        Middleware<NarrowedContext<C, CallbackQueryUpdate<GameQuery>>>,
    >,
): Composer<C>
Registers middleware for handling game queries
Parameters
- ...fns: NonemptyReadonlyArray<
  Middleware<NarrowedContext<C, CallbackQueryUpdate<GameQuery>>>,
  >
Returns Composer<C>
- Defined in composer.ts:171

guard

guard<U extends Update>(
guardFn: (update: Update) => update is U,
...fns: NonemptyReadonlyArray<Middleware<NarrowedContext<C, U>, U>>,
): Composer<C>
Registers middleware for handling updates matching given type guard function.
Type Parameters
- U extends Update
Parameters
- guardFn: (update: Update) => update is U
- ...fns: NonemptyReadonlyArray<Middleware<NarrowedContext<C, U>, U>>
Returns Composer<C>
Deprecated
use Composer::on
- Defined in composer.ts:82

hashtag

hashtag(hashtag: MaybeArray<string>, ...fns: MatchedMiddleware<C>): Composer<C>
Parameters
- hashtag: MaybeArray<string>
- ...fns: MatchedMiddleware<C>
Returns Composer<C>
- Defined in composer.ts:249

hears

hears(
    triggers: Triggers<
        NarrowedContext<
            C,
            { message: New & NonChannel & TextMessage; update_id: number },
        >,
    >,
    ...fns: MatchedMiddleware<C, "text">,
): Composer<C>
Registers middleware for handling matching text messages.
Parameters
- triggers: Triggers<
      NarrowedContext<
          C,
          { message: New & NonChannel & TextMessage; update_id: number },
      >,
  >
- ...fns: MatchedMiddleware<C, "text">
Returns Composer<C>
- Defined in composer.ts:127

help

help(
    ...fns: NonemptyReadonlyArray<
        Middleware<
            Context<
                { message: New & NonChannel & TextMessage; update_id: number },
            > & Omit<C, keyof Context<Update>> & CommandContextExtn,
        >,
    >,
): Composer<C>
Registers a middleware for handling /help
Parameters
- ...fns: NonemptyReadonlyArray<
      Middleware<
          Context<{ message: New & NonChannel & TextMessage; update_id: number }> & Omit<
              C,
              keyof Context<Update>,
          > & CommandContextExtn,
      >,
  >
Returns Composer<C>
- Defined in composer.ts:278

inlineQuery

inlineQuery(
triggers: Triggers<NarrowedContext<C, InlineQueryUpdate>>,
...fns: MatchedMiddleware<C, "inline_query">,
): Composer<C>
Registers middleware for handling matching inline queries.
Parameters
- triggers: Triggers<NarrowedContext<C, InlineQueryUpdate>>
- ...fns: MatchedMiddleware<C, "inline_query">
Returns Composer<C>
- Defined in composer.ts:161

mention

mention(mention: MaybeArray<string>, ...fns: MatchedMiddleware<C>): Composer<C>
Parameters
- mention: MaybeArray<string>
- ...fns: MatchedMiddleware<C>
Returns Composer<C>
- Defined in composer.ts:241

middleware

middleware(): MiddlewareFn<C>
Returns MiddlewareFn<C>
Implementation of MiddlewareObj.middleware
- Defined in composer.ts:301

on

on<Filter extends UpdateType | Guard<C["update"]>>(
filters: MaybeArray<Filter>,
...fns: NonemptyReadonlyArray<Middleware<FilteredContext<C, Filter>>>,
): this
Registers middleware for handling updates narrowed by update types or filter queries.
Type Parameters
- Filter extends UpdateType | Guard<C["update"]>
Parameters
- filters: MaybeArray<Filter>
- ...fns: NonemptyReadonlyArray<Middleware<FilteredContext<C, Filter>>>
Returns this
- Defined in composer.ts:92
on<
    Filter extends
        | "text"
        | "sticker"
        | "animation"
        | "show_caption_above_media"
        | "audio"
        | "document"
        | "photo"
        | "checklist"
        | "video"
        | "video_note"
        | "voice"
        | "callback_query"
        | "channel_post"
        | "chat_member"
        | "chosen_inline_result"
        | "edited_channel_post"
        | "business_connection"
        | "business_message"
        | "edited_business_message"
        | "deleted_business_messages"
        | "message_reaction"
        | "message_reaction_count"
        | "edited_message"
        | "inline_query"
        | "message"
        | "my_chat_member"
        | "pre_checkout_query"
        | "purchased_paid_media"
        | "poll_answer"
        | "poll"
        | "shipping_query"
        | "chat_join_request"
        | "chat_boost"
        | "removed_chat_boost"
        | "new_chat_members"
        | "left_chat_member"
        | "chat_owner_left"
        | "chat_owner_changed"
        | "new_chat_title"
        | "new_chat_photo"
        | "delete_chat_photo"
        | "group_chat_created"
        | "supergroup_chat_created"
        | "refunded_payment"
        | "channel_chat_created"
        | "message_auto_delete_timer_changed"
        | "migrate_to_chat_id"
        | "migrate_from_chat_id"
        | "pinned_message"
        | "invoice"
        | "successful_payment"
        | "users_shared"
        | "chat_shared"
        | "gift"
        | "unique_gift"
        | "gift_upgrade_sent"
        | "connected_website"
        | "write_access_allowed"
        | "passport_data"
        | "proximity_alert_triggered"
        | "boost_added"
        | "chat_background_set"
        | "checklist_tasks_done"
        | "checklist_tasks_added"
        | "direct_message_price_changed"
        | "forum_topic_created"
        | "forum_topic_edited"
        | "forum_topic_closed"
        | "forum_topic_reopened"
        | "general_forum_topic_hidden"
        | "general_forum_topic_unhidden"
        | "giveaway_created"
        | "giveaway"
        | "giveaway_winners"
        | "giveaway_completed"
        | "paid_message_price_changed"
        | "suggested_post_approved"
        | "suggested_post_approval_failed"
        | "suggested_post_declined"
        | "suggested_post_paid"
        | "suggested_post_refunded"
        | "video_chat_scheduled"
        | "video_chat_started"
        | "video_chat_ended"
        | "video_chat_participants_invited"
        | "web_app_data"
        | "has_media_spoiler"
        | "contact"
        | "dice"
        | "game"
        | "location"
        | "story"
        | "venue"
        | "forward_date",
>(
    filters: MaybeArray<Filter>,
    ...fns: NonemptyReadonlyArray<
        Middleware<NarrowedContext<C, MountMap[Filter]>, MountMap[Filter]>,
    >,
): this
Registers middleware for handling updates narrowed by update types or message subtypes.
Type Parameters
- Filter extends
      | "text"
      | "sticker"
      | "animation"
      | "show_caption_above_media"
      | "audio"
      | "document"
      | "photo"
      | "checklist"
      | "video"
      | "video_note"
      | "voice"
      | "callback_query"
      | "channel_post"
      | "chat_member"
      | "chosen_inline_result"
      | "edited_channel_post"
      | "business_connection"
      | "business_message"
      | "edited_business_message"
      | "deleted_business_messages"
      | "message_reaction"
      | "message_reaction_count"
      | "edited_message"
      | "inline_query"
      | "message"
      | "my_chat_member"
      | "pre_checkout_query"
      | "purchased_paid_media"
      | "poll_answer"
      | "poll"
      | "shipping_query"
      | "chat_join_request"
      | "chat_boost"
      | "removed_chat_boost"
      | "new_chat_members"
      | "left_chat_member"
      | "chat_owner_left"
      | "chat_owner_changed"
      | "new_chat_title"
      | "new_chat_photo"
      | "delete_chat_photo"
      | "group_chat_created"
      | "supergroup_chat_created"
      | "refunded_payment"
      | "channel_chat_created"
      | "message_auto_delete_timer_changed"
      | "migrate_to_chat_id"
      | "migrate_from_chat_id"
      | "pinned_message"
      | "invoice"
      | "successful_payment"
      | "users_shared"
      | "chat_shared"
      | "gift"
      | "unique_gift"
      | "gift_upgrade_sent"
      | "connected_website"
      | "write_access_allowed"
      | "passport_data"
      | "proximity_alert_triggered"
      | "boost_added"
      | "chat_background_set"
      | "checklist_tasks_done"
      | "checklist_tasks_added"
      | "direct_message_price_changed"
      | "forum_topic_created"
      | "forum_topic_edited"
      | "forum_topic_closed"
      | "forum_topic_reopened"
      | "general_forum_topic_hidden"
      | "general_forum_topic_unhidden"
      | "giveaway_created"
      | "giveaway"
      | "giveaway_winners"
      | "giveaway_completed"
      | "paid_message_price_changed"
      | "suggested_post_approved"
      | "suggested_post_approval_failed"
      | "suggested_post_declined"
      | "suggested_post_paid"
      | "suggested_post_refunded"
      | "video_chat_scheduled"
      | "video_chat_started"
      | "video_chat_ended"
      | "video_chat_participants_invited"
      | "web_app_data"
      | "has_media_spoiler"
      | "contact"
      | "dice"
      | "game"
      | "location"
      | "story"
      | "venue"
      | "forward_date"
Parameters
- filters: MaybeArray<Filter>
- ...fns: NonemptyReadonlyArray<
  Middleware<NarrowedContext<C, MountMap[Filter]>, MountMap[Filter]>,
  >
Returns this
Deprecated
Use filter utils instead. Support for Message subtype in Composer::on will be removed in Telegraf v5.
- Defined in composer.ts:101

phone

phone(number: Triggers<C>, ...fns: MatchedMiddleware<C>): Composer<C>
Parameters
- number: Triggers<C>
- ...fns: MatchedMiddleware<C>
Returns Composer<C>
- Defined in composer.ts:245

reaction

reaction(
    reaction: MaybeArray<ReactionAddedOrRemoved>,
    ...fns: NonemptyReadonlyArray<
        Middleware<
            Context<MessageReactionUpdate> & Omit<C, keyof Context<Update>> & {
                match: ReactionAddedOrRemoved;
            },
            MessageReactionUpdate,
        >,
    >,
): Composer<C>
Parameters
- reaction: MaybeArray<ReactionAddedOrRemoved>
- ...fns: NonemptyReadonlyArray<
      Middleware<
          Context<MessageReactionUpdate> & Omit<C, keyof Context<Update>> & {
              match: ReactionAddedOrRemoved;
          },
          MessageReactionUpdate,
      >,
  >
Returns Composer<C>
- Defined in composer.ts:184

settings

settings(
    ...fns: NonemptyReadonlyArray<
        Middleware<
            Context<
                { message: New & NonChannel & TextMessage; update_id: number },
            > & Omit<C, keyof Context<Update>> & CommandContextExtn,
        >,
    >,
): Composer<C>
Registers a middleware for handling /settings
Parameters
- ...fns: NonemptyReadonlyArray<
      Middleware<
          Context<{ message: New & NonChannel & TextMessage; update_id: number }> & Omit<
              C,
              keyof Context<Update>,
          > & CommandContextExtn,
      >,
  >
Returns Composer<C>
- Defined in composer.ts:291

spoiler

spoiler(text: Triggers<C>, ...fns: MatchedMiddleware<C>): Composer<C>
Parameters
- text: Triggers<C>
- ...fns: MatchedMiddleware<C>
Returns Composer<C>
- Defined in composer.ts:257

start

start(
    ...fns: NonemptyReadonlyArray<
        Middleware<
            Context<
                { message: New & NonChannel & TextMessage; update_id: number },
            > & Omit<C, keyof Context<Update>> & StartContextExtn,
        >,
    >,
): Composer<C>
Registers a middleware for handling /start
Parameters
- ...fns: NonemptyReadonlyArray<
      Middleware<
          Context<{ message: New & NonChannel & TextMessage; update_id: number }> & Omit<
              C,
              keyof Context<Update>,
          > & StartContextExtn,
      >,
  >
Returns Composer<C>
- Defined in composer.ts:264

textLink

textLink(link: Triggers<C>, ...fns: MatchedMiddleware<C>): Composer<C>
Parameters
- link: Triggers<C>
- ...fns: MatchedMiddleware<C>
Returns Composer<C>
- Defined in composer.ts:233

textMention

textMention(mention: Triggers<C>, ...fns: MatchedMiddleware<C>): Composer<C>
Parameters
- mention: Triggers<C>
- ...fns: MatchedMiddleware<C>
Returns Composer<C>
- Defined in composer.ts:237

url

url(url: Triggers<C>, ...fns: MatchedMiddleware<C>): Composer<C>
Parameters
- url: Triggers<C>
- ...fns: MatchedMiddleware<C>
Returns Composer<C>
- Defined in composer.ts:229

use

use(...fns: readonly Middleware<C>[]): Composer<C>
Registers a middleware.
Parameters
- ...fns: readonly Middleware<C>[]
Returns Composer<C>
- Defined in composer.ts:72

`Static`acl

acl<C extends Context<Update>>(
userId: MaybeArray<number>,
...fns: NonemptyReadonlyArray<Middleware<C>>,
): MiddlewareFn<C>
Generates middleware responding only to specified users.
Type Parameters
- C extends Context<Update>
Parameters
- userId: MaybeArray<number>
- ...fns: NonemptyReadonlyArray<Middleware<C>>
Returns MiddlewareFn<C>
- Defined in composer.ts:821

`Static`action

action<C extends Context<Update>>(
    triggers: Triggers<
        NarrowedContext<C, CallbackQueryUpdate<CallbackQuery>>,
    >,
    ...fns: MatchedMiddleware<C, "callback_query">,
): MiddlewareFn<C>
Generates middleware for handling matching callback queries.
Type Parameters
- C extends Context<Update>
Parameters
- triggers: Triggers<NarrowedContext<C, CallbackQueryUpdate<CallbackQuery>>>
- ...fns: MatchedMiddleware<C, "callback_query">
Returns MiddlewareFn<C>
- Defined in composer.ts:766

`Static`admin

admin<C extends Context<Update>>(
...fns: NonemptyReadonlyArray<Middleware<C>>,
): MiddlewareFn<C>
Generates middleware responding only to chat admins and chat creator.
Type Parameters
- C extends Context<Update>
Parameters
- ...fns: NonemptyReadonlyArray<Middleware<C>>
Returns MiddlewareFn<C>
- Defined in composer.ts:851

`Static`branch

branch<C extends Context<Update>>(
    predicate: boolean | Predicate<C> | AsyncPredicate<C>,
    trueMiddleware: Middleware<C>,
    falseMiddleware: Middleware<C>,
): MiddlewareFn<C>
Type Parameters
- C extends Context<Update>
Parameters
- predicate: boolean | Predicate<C> | AsyncPredicate<C>
- trueMiddleware: Middleware<C>
  middleware to run if the predicate returns true
- falseMiddleware: Middleware<C>
  middleware to run if the predicate returns false
Returns MiddlewareFn<C>
- Defined in composer.ts:365

`Static`cashtag

cashtag<C extends Context<Update>>(
cashtag: MaybeArray<string>,
...fns: MatchedMiddleware<C>,
): MiddlewareFn<C>
Type Parameters
- C extends Context<Update>
Parameters
- cashtag: MaybeArray<string>
- ...fns: MatchedMiddleware<C>
Returns MiddlewareFn<C>
- Defined in composer.ts:651

`Static`catch

catch<C extends Context<Update>>(
errorHandler: (err: unknown, ctx: C) => void,
...fns: readonly Middleware<C>[],
): MiddlewareFn<C>
Type Parameters
- C extends Context<Update>
Parameters
- errorHandler: (err: unknown, ctx: C) => void
- ...fns: readonly Middleware<C>[]
Returns MiddlewareFn<C>
- Defined in composer.ts:309

`Static`chatType

chatType<C extends Context<Update>>(
type: MaybeArray<"channel" | "group" | "supergroup" | "private">,
...fns: NonemptyReadonlyArray<Middleware<C>>,
): MiddlewareFn<C>
Generates middleware running only in specified chat types.
Type Parameters
- C extends Context<Update>
Parameters
- type: MaybeArray<"channel" | "group" | "supergroup" | "private">
- ...fns: NonemptyReadonlyArray<Middleware<C>>
Returns MiddlewareFn<C>
- Defined in composer.ts:869

`Static`command

command<C extends Context<Update>>(
    command: Triggers<
        NarrowedContext<
            C,
            { message: New & NonChannel & TextMessage; update_id: number },
        >,
    >,
    ...fns: NonemptyReadonlyArray<
        Middleware<
            Context<
                { message: New & NonChannel & TextMessage; update_id: number },
            > & Omit<C, keyof Context<Update>> & CommandContextExtn,
        >,
    >,
): MiddlewareFn<C>
Generates middleware for handling specified commands.
Type Parameters
- C extends Context<Update>
Parameters
- command: Triggers<
      NarrowedContext<
          C,
          { message: New & NonChannel & TextMessage; update_id: number },
      >,
  >
- ...fns: NonemptyReadonlyArray<
      Middleware<
          Context<{ message: New & NonChannel & TextMessage; update_id: number }> & Omit<
              C,
              keyof Context<Update>,
          > & CommandContextExtn,
      >,
  >
Returns MiddlewareFn<C>
- Defined in composer.ts:708

`Static`compose

compose<C extends Context<Update>>(
middlewares: readonly Middleware<C>[],
): MiddlewareFn<C>
Type Parameters
- C extends Context<Update>
Parameters
- middlewares: readonly Middleware<C>[]
Returns MiddlewareFn<C>
- Defined in composer.ts:924

`Static`creator

creator<C extends Context<Update>>(
...fns: NonemptyReadonlyArray<Middleware<C>>,
): MiddlewareFn<C>
Generates middleware responding only to chat creator.
Type Parameters
- C extends Context<Update>
Parameters
- ...fns: NonemptyReadonlyArray<Middleware<C>>
Returns MiddlewareFn<C>
- Defined in composer.ts:860

`Static`dispatch

dispatch<
    C extends Context<Update>,
    Handlers extends Record<string | number | symbol, Middleware<C>>,
>(
    routeFn: (ctx: C) => MaybePromise<keyof Handlers>,
    handlers: Handlers,
): Middleware<C>
Type Parameters
- C extends Context<Update>
- Handlers extends Record<string | number | symbol, Middleware<C>>
Parameters
- routeFn: (ctx: C) => MaybePromise<keyof Handlers>
- handlers: Handlers
Returns Middleware<C>
- Defined in composer.ts:408

`Static`drop

drop<C extends Context<Update>>(predicate: Predicate<C>): MiddlewareFn<C>
Generates middleware for dropping matching updates.
Type Parameters
- C extends Context<Update>
Parameters
- predicate: Predicate<C>
Returns MiddlewareFn<C>
- Defined in composer.ts:404

`Static`email

email<C extends Context<Update>>(
email: Triggers<C>,
...fns: MatchedMiddleware<C>,
): MiddlewareFn<C>
Type Parameters
- C extends Context<Update>
Parameters
- email: Triggers<C>
- ...fns: MatchedMiddleware<C>
Returns MiddlewareFn<C>
- Defined in composer.ts:594

`Static`entityText

entityText<C extends Context<Update>>(
    entityType: MaybeArray<string>,
    predicate: Triggers<C>,
    ...fns: MatchedMiddleware<C>,
): MiddlewareFn<C>
Type Parameters
- C extends Context<Update>
Parameters
- entityType: MaybeArray<string>
- predicate: Triggers<C>
- ...fns: MatchedMiddleware<C>
Returns MiddlewareFn<C>
- Defined in composer.ts:562

`Static`filter

filter<C extends Context<Update>>(predicate: Predicate<C>): MiddlewareFn<C>
Type Parameters
- C extends Context<Update>
Parameters
- predicate: Predicate<C>
Returns MiddlewareFn<C>
Deprecated
use Composer.drop
- Defined in composer.ts:397

`Static`fork

fork<C extends Context<Update>>(middleware: Middleware<C>): MiddlewareFn<C>
Generates middleware that runs in the background.
Type Parameters
- C extends Context<Update>
Parameters
- middleware: Middleware<C>
Returns MiddlewareFn<C>
- Defined in composer.ts:322

`Static`gameQuery

gameQuery<C extends Context<Update>>(
    ...fns: NonemptyReadonlyArray<
        Middleware<NarrowedContext<C, CallbackQueryUpdate<GameQuery>>>,
    >,
): MiddlewareFn<C>
Generates middleware for handling game queries.
Type Parameters
- C extends Context<Update>
Parameters
- ...fns: NonemptyReadonlyArray<
  Middleware<NarrowedContext<C, CallbackQueryUpdate<GameQuery>>>,
  >
Returns MiddlewareFn<C>
- Defined in composer.ts:904

`Static`groupChat

groupChat<C extends Context<Update>>(
...fns: NonemptyReadonlyArray<Middleware<C>>,
): MiddlewareFn<C>
Generates middleware running only in groups and supergroups.
Type Parameters
- C extends Context<Update>
Parameters
- ...fns: NonemptyReadonlyArray<Middleware<C>>
Returns MiddlewareFn<C>
- Defined in composer.ts:895

`Static`guard

guard<C extends Context<Update>, U extends Update>(
guardFn: (u: Update) => u is U,
...fns: NonemptyReadonlyArray<Middleware<NarrowedContext<C, U>, U>>,
): MiddlewareFn<C>
Generates optional middleware based on a predicate that only operates on ctx.update.

Example:
```
import { Composer, Update } from 'telegraf'

const predicate = (u): u is Update.MessageUpdate => 'message' in u
const middleware = Composer.guard(predicate, (ctx) => {
  const message = ctx.update.message
})
```
Note that Composer.on('message') is preferred over this.
Type Parameters
- C extends Context<Update>
- U extends Update
Parameters
- guardFn: (u: Update) => u is U
  predicate to decide whether to run the middleware based on the ctx.update object
- ...fns: NonemptyReadonlyArray<Middleware<NarrowedContext<C, U>, U>>
  middleware to run if the predicate returns true
Returns MiddlewareFn<C>
See
Composer.optional for a more generic version of this method that allows the predicate to operate on ctx itself

Deprecated
use Composer.on
- Defined in composer.ts:448

`Static`hashtag

hashtag<C extends Context<Update>>(
hashtag: MaybeArray<string>,
...fns: MatchedMiddleware<C>,
): MiddlewareFn<C>
Type Parameters
- C extends Context<Update>
Parameters
- hashtag: MaybeArray<string>
- ...fns: MatchedMiddleware<C>
Returns MiddlewareFn<C>
- Defined in composer.ts:640

`Static`hears

hears<C extends Context<Update>>(
    triggers: Triggers<
        NarrowedContext<
            C,
            { message: New & NonChannel & TextMessage; update_id: number },
        >,
    >,
    ...fns: MatchedMiddleware<C, "text">,
): MiddlewareFn<C>
Generates middleware for handling matching text messages.
Type Parameters
- C extends Context<Update>
Parameters
- triggers: Triggers<
      NarrowedContext<
          C,
          { message: New & NonChannel & TextMessage; update_id: number },
      >,
  >
- ...fns: MatchedMiddleware<C, "text">
Returns MiddlewareFn<C>
- Defined in composer.ts:692

`Static`inlineQuery

inlineQuery<C extends Context<Update>>(
triggers: Triggers<NarrowedContext<C, InlineQueryUpdate>>,
...fns: MatchedMiddleware<C, "inline_query">,
): MiddlewareFn<C>
Generates middleware for handling matching inline queries.
Type Parameters
- C extends Context<Update>
Parameters
- triggers: Triggers<NarrowedContext<C, InlineQueryUpdate>>
- ...fns: MatchedMiddleware<C, "inline_query">
Returns MiddlewareFn<C>
- Defined in composer.ts:779

`Static`lazy

lazy<C extends Context<Update>>(
factoryFn: (ctx: C) => MaybePromise<Middleware<C>>,
): MiddlewareFn<C>
Type Parameters
- C extends Context<Update>
Parameters
- factoryFn: (ctx: C) => MaybePromise<Middleware<C>>
Returns MiddlewareFn<C>
- Defined in composer.ts:342

`Static`log

log(logFn?: (s: string) => void): MiddlewareFn<Context<Update>>
Parameters
- logFn: (s: string) => void = console.log
Returns MiddlewareFn<Context<Update>>
- Defined in composer.ts:354

`Static`mention

mention<C extends Context<Update>>(
mention: MaybeArray<string>,
...fns: MatchedMiddleware<C>,
): MiddlewareFn<C>
Type Parameters
- C extends Context<Update>
Parameters
- mention: MaybeArray<string>
- ...fns: MatchedMiddleware<C>
Returns MiddlewareFn<C>
- Defined in composer.ts:629

`Static`on

on<
    Ctx extends Context<Update>,
    Filter extends UpdateType | Guard<Ctx["update"]>,
>(
    filters: MaybeArray<Filter>,
    ...fns: NonemptyReadonlyArray<Middleware<FilteredContext<Ctx, Filter>>>,
): MiddlewareFn<Ctx>
Generates middleware for handling updates narrowed by update types or filter queries.
Type Parameters
- Ctx extends Context<Update>
- Filter extends UpdateType | Guard<Ctx["update"]>
Parameters
- filters: MaybeArray<Filter>
- ...fns: NonemptyReadonlyArray<Middleware<FilteredContext<Ctx, Filter>>>
Returns MiddlewareFn<Ctx>
- Defined in composer.ts:462
on<
    Ctx extends Context<Update>,
    Filter extends

            | "text"
            | "sticker"
            | "animation"
            | "show_caption_above_media"
            | "audio"
            | "document"
            | "photo"
            | "checklist"
            | "video"
            | "video_note"
            | "voice"
            | "callback_query"
            | "channel_post"
            | "chat_member"
            | "chosen_inline_result"
            | "edited_channel_post"
            | "business_connection"
            | "business_message"
            | "edited_business_message"
            | "deleted_business_messages"
            | "message_reaction"
            | "message_reaction_count"
            | "edited_message"
            | "inline_query"
            | "message"
            | "my_chat_member"
            | "pre_checkout_query"
            | "purchased_paid_media"
            | "poll_answer"
            | "poll"
            | "shipping_query"
            | "chat_join_request"
            | "chat_boost"
            | "removed_chat_boost"
            | "new_chat_members"
            | "left_chat_member"
            | "chat_owner_left"
            | "chat_owner_changed"
            | "new_chat_title"
            | "new_chat_photo"
            | "delete_chat_photo"
            | "group_chat_created"
            | "supergroup_chat_created"
            | "refunded_payment"
            | "channel_chat_created"
            | "message_auto_delete_timer_changed"
            | "migrate_to_chat_id"
            | "migrate_from_chat_id"
            | "pinned_message"
            | "invoice"
            | "successful_payment"
            | "users_shared"
            | "chat_shared"
            | "gift"
            | "unique_gift"
            | "gift_upgrade_sent"
            | "connected_website"
            | "write_access_allowed"
            | "passport_data"
            | "proximity_alert_triggered"
            | "boost_added"
            | "chat_background_set"
            | "checklist_tasks_done"
            | "checklist_tasks_added"
            | "direct_message_price_changed"
            | "forum_topic_created"
            | "forum_topic_edited"
            | "forum_topic_closed"
            | "forum_topic_reopened"
            | "general_forum_topic_hidden"
            | "general_forum_topic_unhidden"
            | "giveaway_created"
            | "giveaway"
            | "giveaway_winners"
            | "giveaway_completed"
            | "paid_message_price_changed"
            | "suggested_post_approved"
            | "suggested_post_approval_failed"
            | "suggested_post_declined"
            | "suggested_post_paid"
            | "suggested_post_refunded"
            | "video_chat_scheduled"
            | "video_chat_started"
            | "video_chat_ended"
            | "video_chat_participants_invited"
            | "web_app_data"
            | "has_media_spoiler"
            | "contact"
            | "dice"
            | "game"
            | "location"
            | "story"
            | "venue"
            | "forward_date",
>(
    filters: MaybeArray<Filter>,
    ...fns: NonemptyReadonlyArray<
        Middleware<NarrowedContext<Ctx, MountMap[Filter]>, MountMap[Filter]>,
    >,
): MiddlewareFn<Ctx>
Generates middleware for handling updates narrowed by update types or message subtype.
Type Parameters
- Ctx extends Context<Update>
- Filter extends
      | "text"
      | "sticker"
      | "animation"
      | "show_caption_above_media"
      | "audio"
      | "document"
      | "photo"
      | "checklist"
      | "video"
      | "video_note"
      | "voice"
      | "callback_query"
      | "channel_post"
      | "chat_member"
      | "chosen_inline_result"
      | "edited_channel_post"
      | "business_connection"
      | "business_message"
      | "edited_business_message"
      | "deleted_business_messages"
      | "message_reaction"
      | "message_reaction_count"
      | "edited_message"
      | "inline_query"
      | "message"
      | "my_chat_member"
      | "pre_checkout_query"
      | "purchased_paid_media"
      | "poll_answer"
      | "poll"
      | "shipping_query"
      | "chat_join_request"
      | "chat_boost"
      | "removed_chat_boost"
      | "new_chat_members"
      | "left_chat_member"
      | "chat_owner_left"
      | "chat_owner_changed"
      | "new_chat_title"
      | "new_chat_photo"
      | "delete_chat_photo"
      | "group_chat_created"
      | "supergroup_chat_created"
      | "refunded_payment"
      | "channel_chat_created"
      | "message_auto_delete_timer_changed"
      | "migrate_to_chat_id"
      | "migrate_from_chat_id"
      | "pinned_message"
      | "invoice"
      | "successful_payment"
      | "users_shared"
      | "chat_shared"
      | "gift"
      | "unique_gift"
      | "gift_upgrade_sent"
      | "connected_website"
      | "write_access_allowed"
      | "passport_data"
      | "proximity_alert_triggered"
      | "boost_added"
      | "chat_background_set"
      | "checklist_tasks_done"
      | "checklist_tasks_added"
      | "direct_message_price_changed"
      | "forum_topic_created"
      | "forum_topic_edited"
      | "forum_topic_closed"
      | "forum_topic_reopened"
      | "general_forum_topic_hidden"
      | "general_forum_topic_unhidden"
      | "giveaway_created"
      | "giveaway"
      | "giveaway_winners"
      | "giveaway_completed"
      | "paid_message_price_changed"
      | "suggested_post_approved"
      | "suggested_post_approval_failed"
      | "suggested_post_declined"
      | "suggested_post_paid"
      | "suggested_post_refunded"
      | "video_chat_scheduled"
      | "video_chat_started"
      | "video_chat_ended"
      | "video_chat_participants_invited"
      | "web_app_data"
      | "has_media_spoiler"
      | "contact"
      | "dice"
      | "game"
      | "location"
      | "story"
      | "venue"
      | "forward_date"
Parameters
- filters: MaybeArray<Filter>
- ...fns: NonemptyReadonlyArray<
  Middleware<NarrowedContext<Ctx, MountMap[Filter]>, MountMap[Filter]>,
  >
Returns MiddlewareFn<Ctx>
Deprecated
Use filter utils instead. Support for Message subtype in Composer.on will be removed in Telegraf v5.
- Defined in composer.ts:474

`Static`optional

optional<C extends Context<Update>>(
predicate: Predicate<C> | AsyncPredicate<C>,
...fns: NonemptyReadonlyArray<Middleware<C>>,
): MiddlewareFn<C>
Generates optional middleware.
Type Parameters
- C extends Context<Update>
Parameters
- predicate: Predicate<C> | AsyncPredicate<C>
  predicate to decide on a context object whether to run the middleware
- ...fns: NonemptyReadonlyArray<Middleware<C>>
  middleware to run if the predicate returns true
Returns MiddlewareFn<C>
- Defined in composer.ts:385

`Static`passThru

passThru(): MiddlewareFn<Context<Update>>
Generates middleware that gives up control to the next middleware.

Returns MiddlewareFn<Context<Update>>
- Defined in composer.ts:338

`Static`phone

phone<C extends Context<Update>>(
number: Triggers<C>,
...fns: MatchedMiddleware<C>,
): MiddlewareFn<C>
Type Parameters
- C extends Context<Update>
Parameters
- number: Triggers<C>
- ...fns: MatchedMiddleware<C>
Returns MiddlewareFn<C>
- Defined in composer.ts:601

`Static`privateChat

privateChat<C extends Context<Update>>(
...fns: NonemptyReadonlyArray<Middleware<C>>,
): MiddlewareFn<C>
Generates middleware running only in private chats.
Type Parameters
- C extends Context<Update>
Parameters
- ...fns: NonemptyReadonlyArray<Middleware<C>>
Returns MiddlewareFn<C>
- Defined in composer.ts:886

`Static`reaction

reaction<C extends Context<Update>>(
    reaction: MaybeArray<ReactionAddedOrRemoved>,
    ...fns: NonemptyReadonlyArray<
        Middleware<
            Context<MessageReactionUpdate> & Omit<C, keyof Context<Update>> & {
                match: ReactionAddedOrRemoved;
            },
            MessageReactionUpdate,
        >,
    >,
): MiddlewareFn<C>
Type Parameters
- C extends Context<Update>
Parameters
- reaction: MaybeArray<ReactionAddedOrRemoved>
- ...fns: NonemptyReadonlyArray<
      Middleware<
          Context<MessageReactionUpdate> & Omit<C, keyof Context<Update>> & {
              match: ReactionAddedOrRemoved;
          },
          MessageReactionUpdate,
      >,
  >
Returns MiddlewareFn<C>
- Defined in composer.ts:789

`Static`reply

reply(
    ...args: [
        text: string
        | FmtString<string>,
        extra?: Omit<{}, "text" | "chat_id">,
    ],
): MiddlewareFn<Context<Update>>
Parameters
- ...args: [text: string | FmtString<string>, extra?: Omit<{}, "text" | "chat_id">]
Returns MiddlewareFn<Context<Update>>
- Defined in composer.ts:305

`Static`spoiler

spoiler<C extends Context<Update>>(
text: Triggers<C>,
...fns: MatchedMiddleware<C>,
): MiddlewareFn<C>
Type Parameters
- C extends Context<Update>
Parameters
- text: Triggers<C>
- ...fns: MatchedMiddleware<C>
Returns MiddlewareFn<C>
- Defined in composer.ts:662

`Static`tap

tap<C extends Context<Update>>(middleware: Middleware<C>): MiddlewareFn<C>
Type Parameters
- C extends Context<Update>
Parameters
- middleware: Middleware<C>
Returns MiddlewareFn<C>
- Defined in composer.ts:329

`Static`textLink

textLink<C extends Context<Update>>(
link: Triggers<C>,
...fns: MatchedMiddleware<C>,
): MiddlewareFn<C>
Type Parameters
- C extends Context<Update>
Parameters
- link: Triggers<C>
- ...fns: MatchedMiddleware<C>
Returns MiddlewareFn<C>
- Defined in composer.ts:615

`Static`textMention

textMention<C extends Context<Update>>(
mention: Triggers<C>,
...fns: MatchedMiddleware<C>,
): MiddlewareFn<C>
Type Parameters
- C extends Context<Update>
Parameters
- mention: Triggers<C>
- ...fns: MatchedMiddleware<C>
Returns MiddlewareFn<C>
- Defined in composer.ts:622

`Static`unwrap

unwrap<C extends Context<Update>>(handler: Middleware<C>): MiddlewareFn<C>
Type Parameters
- C extends Context<Update>
Parameters
- handler: Middleware<C>
Returns MiddlewareFn<C>
- Defined in composer.ts:917

`Static`url

url<C extends Context<Update>>(
url: Triggers<C>,
...fns: MatchedMiddleware<C>,
): MiddlewareFn<C>
Type Parameters
- C extends Context<Update>
Parameters
- url: Triggers<C>
- ...fns: MatchedMiddleware<C>
Returns MiddlewareFn<C>
- Defined in composer.ts:608

Class Composer<C>

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Composer<C>

Properties

Staticmount

Type Declaration

Type Parameters

Parameters

Returns MiddlewareFn<Ctx>

Type Parameters

Parameters

Returns MiddlewareFn<Ctx>

Deprecated

Deprecated

Methods

action

Parameters

Returns Composer<C>

cashtag

Parameters

Returns Composer<C>

command

Parameters

Returns Composer<C>

drop

Parameters

Returns Composer<C>

email

Parameters

Returns Composer<C>

filter

Parameters

Returns Composer<C>

Deprecated

gameQuery

Parameters

Returns Composer<C>

guard

Type Parameters

Parameters

Returns Composer<C>

Deprecated

hashtag

Parameters

Returns Composer<C>

hears

Parameters

Returns Composer<C>

help

Parameters

Returns Composer<C>

inlineQuery

Parameters

Returns Composer<C>

mention

Parameters

Returns Composer<C>

middleware

Returns MiddlewareFn<C>

on

Type Parameters

Parameters

Returns this

Type Parameters

Parameters

Returns this

Deprecated

phone

Parameters

Returns Composer<C>

`Static`mount

`Static`acl

`Static`action

`Static`admin

`Static`branch

`Static`cashtag

`Static`catch

`Static`chatType

`Static`command

`Static`compose

`Static`creator

`Static`dispatch

`Static`drop