Composer | telegraf.js

Type parameters

C: Context

Hierarchy

Composer
- Telegraf
- Stage
- BaseScene

Implements

MiddlewareObj<C>

Index

Constructors

constructor

Properties

handler

Methods

Constructors

constructor

new Composer<C>(...fns: readonly Middleware<C>[]): Composer<C>

- Defined in composer.ts:76
Type parameters
- C: Context<C>
Parameters
- Rest ...fns: readonly Middleware<C>[]
Returns Composer<C>

Properties

Private handler

handler: MiddlewareFn<C>

Methods

action

action(triggers: MaybeArray<string | RegExp | ((value: string, ctx: C) => null | RegExpExecArray)>, ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, Record<"callback_query", object>>>>): Composer<C>

- Defined in composer.ts:128
Registers middleware for handling matching callback queries.

Parameters
- triggers: MaybeArray<string | RegExp | ((value: string, ctx: C) => null | RegExpExecArray)>
- Rest ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, Record<"callback_query", object>>>>
Returns Composer<C>

cashtag

cashtag(cashtag: MaybeArray<string>, ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, Record<"channel_post", object> | Record<"message", object>>>>): Composer<C>

- Defined in composer.ts:208
Parameters
- cashtag: MaybeArray<string>
- Rest ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, Record<"channel_post", object> | Record<"message", object>>>>
Returns Composer<C>

command

command(command: MaybeArray<string>, ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, { message: Pick<TextMessage & AnimationMessage & DocumentMessage & AudioMessage & ChannelChatCreatedMessage & ConnectedWebsiteMessage & ContactMessage & DeleteChatPhotoMessage & DiceMessage & GameMessage & GroupChatCreatedMessage & InvoiceMessage & LeftChatMemberMessage & LocationMessage & MigrateFromChatIdMessage & MigrateToChatIdMessage & NewChatMembersMessage & NewChatPhotoMessage & NewChatTitleMessage & PassportDataMessage & ProximityAlertTriggeredMessage & PhotoMessage & PinnedMessageMessage & PollMessage & StickerMessage & SuccessfulPaymentMessage & SupergroupChatCreated & VenueMessage & VideoMessage & VideoNoteMessage & VoiceMessage, "text"> }>>>): Composer<C>

- Defined in composer.ts:121
Registers middleware for handling specified commands.

Parameters
- command: MaybeArray<string>
- Rest ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, { message: Pick<TextMessage & AnimationMessage & DocumentMessage & AudioMessage & ChannelChatCreatedMessage & ConnectedWebsiteMessage & ContactMessage & DeleteChatPhotoMessage & DiceMessage & GameMessage & GroupChatCreatedMessage & InvoiceMessage & LeftChatMemberMessage & LocationMessage & MigrateFromChatIdMessage & MigrateToChatIdMessage & NewChatMembersMessage & NewChatPhotoMessage & NewChatTitleMessage & PassportDataMessage & ProximityAlertTriggeredMessage & PhotoMessage & PinnedMessageMessage & PollMessage & StickerMessage & SuccessfulPaymentMessage & SupergroupChatCreated & VenueMessage & VideoMessage & VideoNoteMessage & VoiceMessage, "text"> }>>>
Returns Composer<C>

drop

drop(predicate: Predicate<C>): Composer<C>

- Defined in composer.ts:159
Registers middleware for dropping matching updates.

Parameters
- predicate: Predicate<C>
Returns Composer<C>

email

email(email: MaybeArray<string>, ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, Record<"channel_post", object> | Record<"message", object>>>>): Composer<C>

- Defined in composer.ts:180
Parameters
- email: MaybeArray<string>
- Rest ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, Record<"channel_post", object> | Record<"message", object>>>>
Returns Composer<C>

Private entity

entity<T>(predicate: string | string[] | ((entity: MessageEntity, s: string, ctx: C) => boolean), ...fns: readonly Middleware<GuardedContext<C, MountMap[T]>>[]): Composer<C>

- Defined in composer.ts:167
Type parameters
- T: "text" | "channel_post" | "message" | "poll" | "voice" | "video_note" | "video" | "animation" | "venue" | "supergroup_chat_created" | "successful_payment" | "sticker" | "pinned_message" | "photo" | "new_chat_title" | "new_chat_photo" | "new_chat_members" | "migrate_to_chat_id" | "migrate_from_chat_id" | "location" | "left_chat_member" | "invoice" | "group_chat_created" | "game" | "dice" | "document" | "delete_chat_photo" | "contact" | "channel_chat_created" | "audio" | "connected_website" | "passport_data" | "forward_date" = "channel_post" | "message"
Parameters
- predicate: string | string[] | ((entity: MessageEntity, s: string, ctx: C) => boolean)
- Rest ...fns: readonly Middleware<GuardedContext<C, MountMap[T]>>[]
Returns Composer<C>

filter

filter(predicate: Predicate<C>): Composer<C>

- Defined in composer.ts:163
Parameters
- predicate: Predicate<C>
Returns Composer<C>

gameQuery

gameQuery(...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C, GameQueryUpdate>>>): Composer<C>

- Defined in composer.ts:148
Registers middleware for handling game queries

Parameters
- Rest ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C, GameQueryUpdate>>>
Returns Composer<C>

guard

guard<U>(guardFn: (update: Update) => update is U, ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C, U>>>): Composer<C>

- Defined in composer.ts:94
Registers middleware for handling updates matching given type guard function.

Type parameters
- U: Update
Parameters
- guardFn: (update: Update) => update is U
  - - (update: Update): update is U
    - Parameters
      - update: Update
      Returns update is U
- Rest ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C, U>>>
Returns Composer<C>

hashtag

hashtag(hashtag: MaybeArray<string>, ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, Record<"channel_post", object> | Record<"message", object>>>>): Composer<C>

- Defined in composer.ts:204
Parameters
- hashtag: MaybeArray<string>
- Rest ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, Record<"channel_post", object> | Record<"message", object>>>>
Returns Composer<C>

hears

hears(triggers: MaybeArray<string | RegExp | ((value: string, ctx: C) => null | RegExpExecArray)>, ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, { message: Pick<TextMessage & AnimationMessage & DocumentMessage & AudioMessage & ChannelChatCreatedMessage & ConnectedWebsiteMessage & ContactMessage & DeleteChatPhotoMessage & DiceMessage & GameMessage & GroupChatCreatedMessage & InvoiceMessage & LeftChatMemberMessage & LocationMessage & MigrateFromChatIdMessage & MigrateToChatIdMessage & NewChatMembersMessage & NewChatPhotoMessage & NewChatTitleMessage & PassportDataMessage & ProximityAlertTriggeredMessage & PhotoMessage & PinnedMessageMessage & PollMessage & StickerMessage & SuccessfulPaymentMessage & SupergroupChatCreated & VenueMessage & VideoMessage & VideoNoteMessage & VoiceMessage, "text"> }>>>): Composer<C>

- Defined in composer.ts:114
Registers middleware for handling matching text messages.

Parameters
- triggers: MaybeArray<string | RegExp | ((value: string, ctx: C) => null | RegExpExecArray)>
- Rest ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, { message: Pick<TextMessage & AnimationMessage & DocumentMessage & AudioMessage & ChannelChatCreatedMessage & ConnectedWebsiteMessage & ContactMessage & DeleteChatPhotoMessage & DiceMessage & GameMessage & GroupChatCreatedMessage & InvoiceMessage & LeftChatMemberMessage & LocationMessage & MigrateFromChatIdMessage & MigrateToChatIdMessage & NewChatMembersMessage & NewChatPhotoMessage & NewChatTitleMessage & PassportDataMessage & ProximityAlertTriggeredMessage & PhotoMessage & PinnedMessageMessage & PollMessage & StickerMessage & SuccessfulPaymentMessage & SupergroupChatCreated & VenueMessage & VideoMessage & VideoNoteMessage & VoiceMessage, "text"> }>>>
Returns Composer<C>

help

help(...fns: NonemptyReadonlyArray<Middleware<C>>): Composer<C>

- Defined in composer.ts:226
Registers a middleware for handling /help

Parameters
- Rest ...fns: NonemptyReadonlyArray<Middleware<C>>
Returns Composer<C>

inlineQuery

inlineQuery(triggers: MaybeArray<string | RegExp | ((value: string, ctx: C) => null | RegExpExecArray)>, ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, Record<"inline_query", object>>>>): Composer<C>

- Defined in composer.ts:138
Registers middleware for handling matching inline queries.

Parameters
- triggers: MaybeArray<string | RegExp | ((value: string, ctx: C) => null | RegExpExecArray)>
- Rest ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, Record<"inline_query", object>>>>
Returns Composer<C>

mention

mention(mention: MaybeArray<string>, ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, Record<"channel_post", object> | Record<"message", object>>>>): Composer<C>

- Defined in composer.ts:196
Parameters
- mention: MaybeArray<string>
- Rest ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, Record<"channel_post", object> | Record<"message", object>>>>
Returns Composer<C>

middleware

middleware(): MiddlewareFn<C>

- Defined in composer.ts:237
Returns MiddlewareFn<C>

on

on<T>(updateType: MaybeArray<T>, ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C, MountMap[T]>>>): Composer<C>

- Defined in composer.ts:104
Registers middleware for handling provided update types.

Type parameters
- T: "text" | "callback_query" | "channel_post" | "chosen_inline_result" | "edited_channel_post" | "edited_message" | "inline_query" | "message" | "pre_checkout_query" | "shipping_query" | "poll" | "poll_answer" | "voice" | "video_note" | "video" | "animation" | "venue" | "supergroup_chat_created" | "successful_payment" | "sticker" | "pinned_message" | "photo" | "new_chat_title" | "new_chat_photo" | "new_chat_members" | "migrate_to_chat_id" | "migrate_from_chat_id" | "location" | "left_chat_member" | "invoice" | "group_chat_created" | "game" | "dice" | "document" | "delete_chat_photo" | "contact" | "channel_chat_created" | "audio" | "connected_website" | "passport_data" | "forward_date"
Parameters
- updateType: MaybeArray<T>
- Rest ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C, MountMap[T]>>>
Returns Composer<C>

phone

phone(number: MaybeArray<string>, ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, Record<"channel_post", object> | Record<"message", object>>>>): Composer<C>

- Defined in composer.ts:200
Parameters
- number: MaybeArray<string>
- Rest ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, Record<"channel_post", object> | Record<"message", object>>>>
Returns Composer<C>

settings

settings(...fns: NonemptyReadonlyArray<Middleware<C>>): Composer<C>

- Defined in composer.ts:233
Registers a middleware for handling /settings

Parameters
- Rest ...fns: NonemptyReadonlyArray<Middleware<C>>
Returns Composer<C>

start

start(...fns: readonly Middleware<C & { startPayload: string }>[]): Composer<C>

- Defined in composer.ts:215
Registers a middleware for handling /start

Parameters
- Rest ...fns: readonly Middleware<C & { startPayload: string }>[]
Returns Composer<C>

textLink

textLink(link: MaybeArray<string>, ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, Record<"channel_post", object> | Record<"message", object>>>>): Composer<C>

- Defined in composer.ts:188
Parameters
- link: MaybeArray<string>
- Rest ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, Record<"channel_post", object> | Record<"message", object>>>>
Returns Composer<C>

textMention

textMention(mention: MaybeArray<string>, ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, Record<"channel_post", object> | Record<"message", object>>>>): Composer<C>

- Defined in composer.ts:192
Parameters
- mention: MaybeArray<string>
- Rest ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, Record<"channel_post", object> | Record<"message", object>>>>
Returns Composer<C>

url

url(url: MaybeArray<string>, ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, Record<"channel_post", object> | Record<"message", object>>>>): Composer<C>

- Defined in composer.ts:184
Parameters
- url: MaybeArray<string>
- Rest ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, Record<"channel_post", object> | Record<"message", object>>>>
Returns Composer<C>

use

use(...fns: readonly Middleware<C>[]): Composer<C>

- Defined in composer.ts:85
Registers a middleware.

Parameters
- Rest ...fns: readonly Middleware<C>[]
Returns Composer<C>

Static acl

acl<C>(userId: MaybeArray<number>, ...fns: NonemptyReadonlyArray<Middleware<C>>): MiddlewareFn<C>

- Defined in composer.ts:660
Generates middleware responding only to specified users.

Type parameters
- C: Context<C>
Parameters
- userId: MaybeArray<number>
- Rest ...fns: NonemptyReadonlyArray<Middleware<C>>
Returns MiddlewareFn<C>

Static action

action<C>(triggers: MaybeArray<string | RegExp | ((value: string, ctx: C) => null | RegExpExecArray)>, ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, Record<"callback_query", object>>>>): MiddlewareFn<C>

- Defined in composer.ts:634
Generates middleware for handling matching callback queries.

Type parameters
- C: Context<C>
Parameters
- triggers: MaybeArray<string | RegExp | ((value: string, ctx: C) => null | RegExpExecArray)>
- Rest ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, Record<"callback_query", object>>>>
Returns MiddlewareFn<C>

Static admin

admin<C>(...fns: NonemptyReadonlyArray<Middleware<C>>): MiddlewareFn<C>

- Defined in composer.ts:687
Generates middleware responding only to chat admins and chat creator.

Type parameters
- C: Context<C>
Parameters
- Rest ...fns: NonemptyReadonlyArray<Middleware<C>>
Returns MiddlewareFn<C>

Static branch

branch<C>(predicate: Predicate<C> | AsyncPredicate<C>, trueMiddleware: Middleware<C>, falseMiddleware: Middleware<C>): MiddlewareFn<C>

- Defined in composer.ts:301
Type parameters
- C: Context<C>
Parameters
- predicate: 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>

Static cashtag

cashtag<C>(cashtag: MaybeArray<string>, ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, Record<"channel_post", object> | Record<"message", object>>>>): MiddlewareFn<C>

- Defined in composer.ts:545
Type parameters
- C: Context<C>
Parameters
- cashtag: MaybeArray<string>
- Rest ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, Record<"channel_post", object> | Record<"message", object>>>>
Returns MiddlewareFn<C>

Static catch

catch<C>(errorHandler: (err: unknown, ctx: C) => void, ...fns: readonly Middleware<C>[]): MiddlewareFn<C>

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

Static chatType

chatType<C>(type: MaybeArray<"group" | "channel" | "supergroup" | "private">, ...fns: NonemptyReadonlyArray<Middleware<C>>): MiddlewareFn<C>

- Defined in composer.ts:705
Generates middleware running only in specified chat types.

Type parameters
- C: Context<C>
Parameters
- type: MaybeArray<"group" | "channel" | "supergroup" | "private">
- Rest ...fns: NonemptyReadonlyArray<Middleware<C>>
Returns MiddlewareFn<C>

Static command

command<C>(command: MaybeArray<string>, ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, { message: Pick<TextMessage & AnimationMessage & DocumentMessage & AudioMessage & ChannelChatCreatedMessage & ConnectedWebsiteMessage & ContactMessage & DeleteChatPhotoMessage & DiceMessage & GameMessage & GroupChatCreatedMessage & InvoiceMessage & LeftChatMemberMessage & LocationMessage & MigrateFromChatIdMessage & MigrateToChatIdMessage & NewChatMembersMessage & NewChatPhotoMessage & NewChatTitleMessage & PassportDataMessage & ProximityAlertTriggeredMessage & PhotoMessage & PinnedMessageMessage & PollMessage & StickerMessage & SuccessfulPaymentMessage & SupergroupChatCreated & VenueMessage & VideoMessage & VideoNoteMessage & VoiceMessage, "text"> }>>>): MiddlewareFn<C>

- Defined in composer.ts:603
Generates middleware for handling specified commands.

Type parameters
- C: Context<C>
Parameters
- command: MaybeArray<string>
- Rest ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, { message: Pick<TextMessage & AnimationMessage & DocumentMessage & AudioMessage & ChannelChatCreatedMessage & ConnectedWebsiteMessage & ContactMessage & DeleteChatPhotoMessage & DiceMessage & GameMessage & GroupChatCreatedMessage & InvoiceMessage & LeftChatMemberMessage & LocationMessage & MigrateFromChatIdMessage & MigrateToChatIdMessage & NewChatMembersMessage & NewChatPhotoMessage & NewChatTitleMessage & PassportDataMessage & ProximityAlertTriggeredMessage & PhotoMessage & PinnedMessageMessage & PollMessage & StickerMessage & SuccessfulPaymentMessage & SupergroupChatCreated & VenueMessage & VideoMessage & VideoNoteMessage & VoiceMessage, "text"> }>>>
Returns MiddlewareFn<C>

Static compose

compose<C>(middlewares: readonly Middleware<C>[]): MiddlewareFn<C>

- Defined in composer.ts:756
Type parameters
- C: Context<C>
Parameters
- middlewares: readonly Middleware<C>[]
Returns MiddlewareFn<C>

Static creator

creator<C>(...fns: NonemptyReadonlyArray<Middleware<C>>): MiddlewareFn<C>

- Defined in composer.ts:696
Generates middleware responding only to chat creator.

Type parameters
- C: Context<C>
Parameters
- Rest ...fns: NonemptyReadonlyArray<Middleware<C>>
Returns MiddlewareFn<C>

Static dispatch

dispatch<C, Handlers>(routeFn: (ctx: C) => MaybePromise<keyof Handlers>, handlers: Handlers): Middleware<C>

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

Static drop

drop<C>(predicate: Predicate<C>): MiddlewareFn<C>

- Defined in composer.ts:339
Generates middleware for dropping matching updates.

Type parameters
- C: Context<C>
Parameters
- predicate: Predicate<C>
Returns MiddlewareFn<C>

Static email

email<C>(email: MaybeArray<string>, ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, Record<"channel_post", object> | Record<"message", object>>>>): MiddlewareFn<C>

- Defined in composer.ts:488
Type parameters
- C: Context<C>
Parameters
- email: MaybeArray<string>
- Rest ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, Record<"channel_post", object> | Record<"message", object>>>>
Returns MiddlewareFn<C>

Private Static entity

entity<C, T>(predicate: string | string[] | ((entity: MessageEntity, s: string, ctx: C) => boolean), ...fns: readonly Middleware<GuardedContext<C, MountMap[T]>>[]): MiddlewareFn<C>

- Defined in composer.ts:425
Type parameters
- C: Context<C>
- T: "text" | "channel_post" | "message" | "poll" | "voice" | "video_note" | "video" | "animation" | "venue" | "supergroup_chat_created" | "successful_payment" | "sticker" | "pinned_message" | "photo" | "new_chat_title" | "new_chat_photo" | "new_chat_members" | "migrate_to_chat_id" | "migrate_from_chat_id" | "location" | "left_chat_member" | "invoice" | "group_chat_created" | "game" | "dice" | "document" | "delete_chat_photo" | "contact" | "channel_chat_created" | "audio" | "connected_website" | "passport_data" | "forward_date" = "channel_post" | "message"
Parameters
- predicate: string | string[] | ((entity: MessageEntity, s: string, ctx: C) => boolean)
- Rest ...fns: readonly Middleware<GuardedContext<C, MountMap[T]>>[]
Returns MiddlewareFn<C>

Static entityText

entityText<C>(entityType: MaybeArray<string>, predicate: MaybeArray<string | RegExp | ((value: string, ctx: C) => null | RegExpExecArray)>, ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, Record<"channel_post", object> | Record<"message", object>>>>): MiddlewareFn<C>

- Defined in composer.ts:459
Type parameters
- C: Context<C>
Parameters
- entityType: MaybeArray<string>
- predicate: MaybeArray<string | RegExp | ((value: string, ctx: C) => null | RegExpExecArray)>
- Rest ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, Record<"channel_post", object> | Record<"message", object>>>>
Returns MiddlewareFn<C>

Static filter

filter<C>(predicate: Predicate<C>): MiddlewareFn<C>

- Defined in composer.ts:332
Type parameters
- C: Context<C>
Parameters
- predicate: Predicate<C>
Returns MiddlewareFn<C>

Static fork

fork<C>(middleware: Middleware<C>): MiddlewareFn<C>

- Defined in composer.ts:258
Generates middleware that runs in the background.

Type parameters
- C: Context<C>
Parameters
- middleware: Middleware<C>
Returns MiddlewareFn<C>

Static gameQuery

gameQuery<C>(...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C, GameQueryUpdate>>>): MiddlewareFn<C>

- Defined in composer.ts:737
Generates middleware for handling game queries.

Type parameters
- C: Context<C>
Parameters
- Rest ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C, GameQueryUpdate>>>
Returns MiddlewareFn<C>

Static groupChat

groupChat<C>(...fns: NonemptyReadonlyArray<Middleware<C>>): MiddlewareFn<C>

- Defined in composer.ts:728
Generates middleware running only in groups and supergroups.

Type parameters
- C: Context<C>
Parameters
- Rest ...fns: NonemptyReadonlyArray<Middleware<C>>
Returns MiddlewareFn<C>

Static guard

guard<C, U>(guardFn: (u: Update) => u is U, ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C, U>>>): MiddlewareFn<C>

- Defined in composer.ts:382
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.mount('message') is preferred over this.

see

Composer.optional for a more generic version of this method that allows the predicate to operate on ctx itself
Type parameters
- C: Context<C>
- U: Update
Parameters
- guardFn: (u: Update) => u is U
  
  predicate to decide whether to run the middleware based on the ctx.update object
  - - (u: Update): u is U
    - Parameters
      - u: Update
      Returns u is U
- Rest ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C, U>>>
  
  middleware to run if the predicate returns true
Returns MiddlewareFn<C>

Static hashtag

hashtag<C>(hashtag: MaybeArray<string>, ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, Record<"channel_post", object> | Record<"message", object>>>>): MiddlewareFn<C>

- Defined in composer.ts:534
Type parameters
- C: Context<C>
Parameters
- hashtag: MaybeArray<string>
- Rest ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, Record<"channel_post", object> | Record<"message", object>>>>
Returns MiddlewareFn<C>

Static hears

hears<C>(triggers: MaybeArray<string | RegExp | ((value: string, ctx: C) => null | RegExpExecArray)>, ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, { message: Pick<TextMessage & AnimationMessage & DocumentMessage & AudioMessage & ChannelChatCreatedMessage & ConnectedWebsiteMessage & ContactMessage & DeleteChatPhotoMessage & DiceMessage & GameMessage & GroupChatCreatedMessage & InvoiceMessage & LeftChatMemberMessage & LocationMessage & MigrateFromChatIdMessage & MigrateToChatIdMessage & NewChatMembersMessage & NewChatPhotoMessage & NewChatTitleMessage & PassportDataMessage & ProximityAlertTriggeredMessage & PhotoMessage & PinnedMessageMessage & PollMessage & StickerMessage & SuccessfulPaymentMessage & SupergroupChatCreated & VenueMessage & VideoMessage & VideoNoteMessage & VoiceMessage, "text"> }>>>): MiddlewareFn<C>

- Defined in composer.ts:590
Generates middleware for handling matching text messages.

Type parameters
- C: Context<C>
Parameters
- triggers: MaybeArray<string | RegExp | ((value: string, ctx: C) => null | RegExpExecArray)>
- Rest ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, { message: Pick<TextMessage & AnimationMessage & DocumentMessage & AudioMessage & ChannelChatCreatedMessage & ConnectedWebsiteMessage & ContactMessage & DeleteChatPhotoMessage & DiceMessage & GameMessage & GroupChatCreatedMessage & InvoiceMessage & LeftChatMemberMessage & LocationMessage & MigrateFromChatIdMessage & MigrateToChatIdMessage & NewChatMembersMessage & NewChatPhotoMessage & NewChatTitleMessage & PassportDataMessage & ProximityAlertTriggeredMessage & PhotoMessage & PinnedMessageMessage & PollMessage & StickerMessage & SuccessfulPaymentMessage & SupergroupChatCreated & VenueMessage & VideoMessage & VideoNoteMessage & VoiceMessage, "text"> }>>>
Returns MiddlewareFn<C>

Static inlineQuery

inlineQuery<C>(triggers: MaybeArray<string | RegExp | ((value: string, ctx: C) => null | RegExpExecArray)>, ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, Record<"inline_query", object>>>>): MiddlewareFn<C>

- Defined in composer.ts:647
Generates middleware for handling matching inline queries.

Type parameters
- C: Context<C>
Parameters
- triggers: MaybeArray<string | RegExp | ((value: string, ctx: C) => null | RegExpExecArray)>
- Rest ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, Record<"inline_query", object>>>>
Returns MiddlewareFn<C>

Static lazy

lazy<C>(factoryFn: (ctx: C) => MaybePromise<Middleware<C>>): MiddlewareFn<C>

- Defined in composer.ts:278
Type parameters
- C: Context<C>
Parameters
- factoryFn: (ctx: C) => MaybePromise<Middleware<C>>
  - - (ctx: C): MaybePromise<Middleware<C>>
    - Parameters
      - ctx: C
      Returns MaybePromise<Middleware<C>>
Returns MiddlewareFn<C>

Static log

log(logFn?: (s: string) => void): MiddlewareFn<Context>

- Defined in composer.ts:290
Parameters
- logFn: (s: string) => void = ...
  - - (s: string): void
    - Parameters
      - s: string
      Returns void
Returns MiddlewareFn<Context>

Private Static match

match<C, T>(triggers: readonly ((text: string, ctx: C) => null | RegExpExecArray)[], ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, MountMap[T]>>>): MiddlewareFn<C>

- Defined in composer.ts:556
Type parameters
- C: Context<C>
- T: "text" | "callback_query" | "channel_post" | "inline_query" | "message" | "poll" | "voice" | "video_note" | "video" | "animation" | "venue" | "supergroup_chat_created" | "successful_payment" | "sticker" | "pinned_message" | "photo" | "new_chat_title" | "new_chat_photo" | "new_chat_members" | "migrate_to_chat_id" | "migrate_from_chat_id" | "location" | "left_chat_member" | "invoice" | "group_chat_created" | "game" | "dice" | "document" | "delete_chat_photo" | "contact" | "channel_chat_created" | "audio" | "connected_website" | "passport_data" | "forward_date"
Parameters
- triggers: readonly ((text: string, ctx: C) => null | RegExpExecArray)[]
- Rest ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, MountMap[T]>>>
Returns MiddlewareFn<C>

Private Static memberStatus

memberStatus<C>(status: MaybeArray<"creator" | "administrator" | "member" | "restricted" | "left" | "kicked">, ...fns: NonemptyReadonlyArray<Middleware<C>>): MiddlewareFn<C>

- Defined in composer.ts:672
Type parameters
- C: Context<C>
Parameters
- status: MaybeArray<"creator" | "administrator" | "member" | "restricted" | "left" | "kicked">
- Rest ...fns: NonemptyReadonlyArray<Middleware<C>>
Returns MiddlewareFn<C>

Static mention

mention<C>(mention: MaybeArray<string>, ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, Record<"channel_post", object> | Record<"message", object>>>>): MiddlewareFn<C>

- Defined in composer.ts:523
Type parameters
- C: Context<C>
Parameters
- mention: MaybeArray<string>
- Rest ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, Record<"channel_post", object> | Record<"message", object>>>>
Returns MiddlewareFn<C>

Static mount

mount<C, T>(updateType: MaybeArray<T>, ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C, MountMap[T]>>>): MiddlewareFn<C>

- Defined in composer.ts:397
Generates middleware for handling provided update types.

deprecated

use Composer.on

Type parameters
- C: Context<C>
- T: "text" | "callback_query" | "channel_post" | "chosen_inline_result" | "edited_channel_post" | "edited_message" | "inline_query" | "message" | "pre_checkout_query" | "shipping_query" | "poll" | "poll_answer" | "voice" | "video_note" | "video" | "animation" | "venue" | "supergroup_chat_created" | "successful_payment" | "sticker" | "pinned_message" | "photo" | "new_chat_title" | "new_chat_photo" | "new_chat_members" | "migrate_to_chat_id" | "migrate_from_chat_id" | "location" | "left_chat_member" | "invoice" | "group_chat_created" | "game" | "dice" | "document" | "delete_chat_photo" | "contact" | "channel_chat_created" | "audio" | "connected_website" | "passport_data" | "forward_date"
Parameters
- updateType: MaybeArray<T>
- Rest ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C, MountMap[T]>>>
Returns MiddlewareFn<C>

Static on

on<C, T>(updateType: MaybeArray<T>, ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C, MountMap[T]>>>): MiddlewareFn<C>

- Defined in composer.ts:407
Generates middleware for handling provided update types.

Type parameters
- C: Context<C>
- T: "text" | "callback_query" | "channel_post" | "chosen_inline_result" | "edited_channel_post" | "edited_message" | "inline_query" | "message" | "pre_checkout_query" | "shipping_query" | "poll" | "poll_answer" | "voice" | "video_note" | "video" | "animation" | "venue" | "supergroup_chat_created" | "successful_payment" | "sticker" | "pinned_message" | "photo" | "new_chat_title" | "new_chat_photo" | "new_chat_members" | "migrate_to_chat_id" | "migrate_from_chat_id" | "location" | "left_chat_member" | "invoice" | "group_chat_created" | "game" | "dice" | "document" | "delete_chat_photo" | "contact" | "channel_chat_created" | "audio" | "connected_website" | "passport_data" | "forward_date"
Parameters
- updateType: MaybeArray<T>
- Rest ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C, MountMap[T]>>>
Returns MiddlewareFn<C>

Static optional

optional<C>(predicate: Predicate<C> | AsyncPredicate<C>, ...fns: NonemptyReadonlyArray<Middleware<C>>): MiddlewareFn<C>

- Defined in composer.ts:321
Generates optional middleware.

Type parameters
- C: Context<C>
Parameters
- predicate: Predicate<C> | AsyncPredicate<C>
  
  predicate to decide on a context object whether to run the middleware
- Rest ...fns: NonemptyReadonlyArray<Middleware<C>>
Returns MiddlewareFn<C>

Static passThru

passThru(): MiddlewareFn<Context>

- Defined in composer.ts:274
Generates middleware that gives up control to the next middleware.

Returns MiddlewareFn<Context>

Static phone

phone<C>(number: MaybeArray<string>, ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, Record<"channel_post", object> | Record<"message", object>>>>): MiddlewareFn<C>

- Defined in composer.ts:495
Type parameters
- C: Context<C>
Parameters
- number: MaybeArray<string>
- Rest ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, Record<"channel_post", object> | Record<"message", object>>>>
Returns MiddlewareFn<C>

Static privateChat

privateChat<C>(...fns: NonemptyReadonlyArray<Middleware<C>>): MiddlewareFn<C>

- Defined in composer.ts:719
Generates middleware running only in private chats.

Type parameters
- C: Context<C>
Parameters
- Rest ...fns: NonemptyReadonlyArray<Middleware<C>>
Returns MiddlewareFn<C>

Static reply

reply(...args: [text: string, extra?: Pick<{}, "parse_mode" | "entities" | "disable_web_page_preview" | "disable_notification" | "reply_to_message_id" | "allow_sending_without_reply" | "reply_markup">]): MiddlewareFn<Context>

- Defined in composer.ts:241
Parameters
- Rest ...args: [text: string, extra?: Pick<{}, "parse_mode" | "entities" | "disable_web_page_preview" | "disable_notification" | "reply_to_message_id" | "allow_sending_without_reply" | "reply_markup">]
Returns MiddlewareFn<Context>

Static tap

tap<C>(middleware: Middleware<C>): MiddlewareFn<C>

- Defined in composer.ts:265
Type parameters
- C: Context<C>
Parameters
- middleware: Middleware<C>
Returns MiddlewareFn<C>

Static textLink

textLink<C>(link: MaybeArray<string>, ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, Record<"channel_post", object> | Record<"message", object>>>>): MiddlewareFn<C>

- Defined in composer.ts:509
Type parameters
- C: Context<C>
Parameters
- link: MaybeArray<string>
- Rest ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, Record<"channel_post", object> | Record<"message", object>>>>
Returns MiddlewareFn<C>

Static textMention

textMention<C>(mention: MaybeArray<string>, ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, Record<"channel_post", object> | Record<"message", object>>>>): MiddlewareFn<C>

- Defined in composer.ts:516
Type parameters
- C: Context<C>
Parameters
- mention: MaybeArray<string>
- Rest ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, Record<"channel_post", object> | Record<"message", object>>>>
Returns MiddlewareFn<C>

Static unwrap

unwrap<C>(handler: Middleware<C>): MiddlewareFn<C>

- Defined in composer.ts:749
Type parameters
- C: Context<C>
Parameters
- handler: Middleware<C>
Returns MiddlewareFn<C>

Static url

url<C>(url: MaybeArray<string>, ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, Record<"channel_post", object> | Record<"message", object>>>>): MiddlewareFn<C>

- Defined in composer.ts:502
Type parameters
- C: Context<C>
Parameters
- url: MaybeArray<string>
- Rest ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, Record<"channel_post", object> | Record<"message", object>>>>
Returns MiddlewareFn<C>

Type parameters

C: Context

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type parameters

C: Context<C>

Parameters

Rest ...fns: readonly Middleware<C>[]

Returns Composer<C>

Properties

Private handler

Methods

action

Parameters

triggers: MaybeArray<string | RegExp | ((value: string, ctx: C) => null | RegExpExecArray)>

Rest ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, Record<"callback_query", object>>>>

Returns Composer<C>

cashtag

Parameters

cashtag: MaybeArray<string>

Rest ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, Record<"channel_post", object> | Record<"message", object>>>>

Returns Composer<C>

command

Parameters

command: MaybeArray<string>

Returns Composer<C>

drop

Parameters

predicate: Predicate<C>

Returns Composer<C>

email

Parameters

email: MaybeArray<string>

Rest ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, Record<"channel_post", object> | Record<"message", object>>>>

Returns Composer<C>

Private entity

Type parameters

Parameters

predicate: string | string[] | ((entity: MessageEntity, s: string, ctx: C) => boolean)

Rest ...fns: readonly Middleware<GuardedContext<C, MountMap[T]>>[]

Returns Composer<C>

filter

Parameters

predicate: Predicate<C>

Returns Composer<C>

gameQuery

Parameters

Rest ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C, GameQueryUpdate>>>

Returns Composer<C>

guard

Type parameters

U: Update

Parameters

guardFn: (update: Update) => update is U

Parameters

update: Update

Returns update is U

Rest ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C, U>>>

Returns Composer<C>

hashtag

Parameters

hashtag: MaybeArray<string>

Rest ...fns: NonemptyReadonlyArray<Middleware<GuardedContext<C & { match: RegExpExecArray }, Record<"channel_post", object> | Record<"message", object>>>>

Returns Composer<C>

hears

Parameters

triggers: MaybeArray<string | RegExp | ((value: string, ctx: C) => null | RegExpExecArray)>

Returns Composer<C>

help

Parameters

Rest ...fns: NonemptyReadonlyArray<Middleware<C>>

Returns Composer<C>

inlineQuery

Parameters