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:55
Type parameters
- C: Context<Update, C>
Parameters
- Rest ...fns: readonly Middleware<C>[]
Returns Composer<C>

Properties

Private handler

handler: MiddlewareFn<C>

Methods

action

action(triggers: Triggers<C>, ...fns: MatchedMiddleware<C, "callback_query">): Composer<C>

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

Parameters
- triggers: Triggers<C>
- Rest ...fns: MatchedMiddleware<C, "callback_query">
Returns Composer<C>

cashtag

cashtag(cashtag: MaybeArray<string>, ...fns: MatchedMiddleware<C, "message" | "channel_post">): Composer<C>

- Defined in composer.ts:190
Parameters
- cashtag: MaybeArray<string>
- Rest ...fns: MatchedMiddleware<C, "message" | "channel_post">
Returns Composer<C>

command

command(command: MaybeArray<string>, ...fns: NonemptyReadonlyArray<Middleware<MatchedContext<C, "text">>>): Composer<C>

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

Parameters
- command: MaybeArray<string>
- Rest ...fns: NonemptyReadonlyArray<Middleware<MatchedContext<C, "text">>>
Returns Composer<C>

drop

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

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

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

email

email(email: Triggers<C>, ...fns: MatchedMiddleware<C, "message" | "channel_post">): Composer<C>

- Defined in composer.ts:162
Parameters
- email: Triggers<C>
- Rest ...fns: MatchedMiddleware<C, "message" | "channel_post">
Returns Composer<C>

Private entity

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

- Defined in composer.ts:149
Type parameters
- T: "message" | "channel_post" | MessageSubType = "message" | "channel_post"
Parameters
- predicate: MaybeArray<string> | ((entity: MessageEntity, s: string, ctx: C) => boolean)
- Rest ...fns: readonly Middleware<MatchedContext<C, T>>[]
Returns Composer<C>

filter

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

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

gameQuery

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

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

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

guard

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

- Defined in composer.ts:73
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<NarrowedContext<C, U>>>
Returns Composer<C>

hashtag

hashtag(hashtag: MaybeArray<string>, ...fns: MatchedMiddleware<C, "message" | "channel_post">): Composer<C>

- Defined in composer.ts:186
Parameters
- hashtag: MaybeArray<string>
- Rest ...fns: MatchedMiddleware<C, "message" | "channel_post">
Returns Composer<C>

hears

hears(triggers: Triggers<C>, ...fns: MatchedMiddleware<C, "text">): Composer<C>

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

Parameters
- triggers: Triggers<C>
- Rest ...fns: MatchedMiddleware<C, "text">
Returns Composer<C>

help

help(...fns: NonemptyReadonlyArray<Middleware<MatchedContext<C, "text">>>): Composer<C>

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

Parameters
- Rest ...fns: NonemptyReadonlyArray<Middleware<MatchedContext<C, "text">>>
Returns Composer<C>

inlineQuery

inlineQuery(triggers: Triggers<C>, ...fns: MatchedMiddleware<C, "inline_query">): Composer<C>

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

Parameters
- triggers: Triggers<C>
- Rest ...fns: MatchedMiddleware<C, "inline_query">
Returns Composer<C>

mention

mention(mention: MaybeArray<string>, ...fns: MatchedMiddleware<C, "message" | "channel_post">): Composer<C>

- Defined in composer.ts:178
Parameters
- mention: MaybeArray<string>
- Rest ...fns: MatchedMiddleware<C, "message" | "channel_post">
Returns Composer<C>

middleware

middleware(): MiddlewareFn<C>

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

on

on<T>(updateType: MaybeArray<T>, ...fns: NonemptyReadonlyArray<Middleware<MatchedContext<C, T>>>): Composer<C>

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

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

phone

phone(number: Triggers<C>, ...fns: MatchedMiddleware<C, "message" | "channel_post">): Composer<C>

- Defined in composer.ts:182
Parameters
- number: Triggers<C>
- Rest ...fns: MatchedMiddleware<C, "message" | "channel_post">
Returns Composer<C>

settings

settings(...fns: NonemptyReadonlyArray<Middleware<MatchedContext<C, "text">>>): Composer<C>

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

Parameters
- Rest ...fns: NonemptyReadonlyArray<Middleware<MatchedContext<C, "text">>>
Returns Composer<C>

start

start(...fns: NonemptyReadonlyArray<Middleware<Context<{ message: New & NonChannel & TextMessage; update_id: number }> & Omit<C, keyof Context<Update>> & { startPayload: string }>>): Composer<C>

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

Parameters
- Rest ...fns: NonemptyReadonlyArray<Middleware<Context<{ message: New & NonChannel & TextMessage; update_id: number }> & Omit<C, keyof Context<Update>> & { startPayload: string }>>
Returns Composer<C>

textLink

textLink(link: Triggers<C>, ...fns: MatchedMiddleware<C, "message" | "channel_post">): Composer<C>

- Defined in composer.ts:170
Parameters
- link: Triggers<C>
- Rest ...fns: MatchedMiddleware<C, "message" | "channel_post">
Returns Composer<C>

textMention

textMention(mention: Triggers<C>, ...fns: MatchedMiddleware<C, "message" | "channel_post">): Composer<C>

- Defined in composer.ts:174
Parameters
- mention: Triggers<C>
- Rest ...fns: MatchedMiddleware<C, "message" | "channel_post">
Returns Composer<C>

url

url(url: Triggers<C>, ...fns: MatchedMiddleware<C, "message" | "channel_post">): Composer<C>

- Defined in composer.ts:166
Parameters
- url: Triggers<C>
- Rest ...fns: MatchedMiddleware<C, "message" | "channel_post">
Returns Composer<C>

use

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

- Defined in composer.ts:64
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:652
Generates middleware responding only to specified users.

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

Static action

action<C>(triggers: Triggers<C>, ...fns: MatchedMiddleware<C, "callback_query">): MiddlewareFn<C>

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

Type parameters
- C: Context<Update, C>
Parameters
- triggers: Triggers<C>
- Rest ...fns: MatchedMiddleware<C, "callback_query">
Returns MiddlewareFn<C>

Static admin

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

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

Type parameters
- C: Context<Update, 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:290
Type parameters
- C: Context<Update, 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: MatchedMiddleware<C, "message" | "channel_post">): MiddlewareFn<C>

- Defined in composer.ts:536
Type parameters
- C: Context<Update, C>
Parameters
- cashtag: MaybeArray<string>
- Rest ...fns: MatchedMiddleware<C, "message" | "channel_post">
Returns MiddlewareFn<C>

Static catch

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

- Defined in composer.ts:234
Type parameters
- C: Context<Update, 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<"channel" | "private" | "group" | "supergroup">, ...fns: NonemptyReadonlyArray<Middleware<C>>): MiddlewareFn<C>

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

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

Static command

command<C>(command: MaybeArray<string>, ...fns: NonemptyReadonlyArray<Middleware<MatchedContext<C, "text">>>): MiddlewareFn<C>

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

Type parameters
- C: Context<Update, C>
Parameters
- command: MaybeArray<string>
- Rest ...fns: NonemptyReadonlyArray<Middleware<MatchedContext<C, "text">>>
Returns MiddlewareFn<C>

Static compose

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

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

Static creator

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

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

Type parameters
- C: Context<Update, 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:332
Type parameters
- C: Context<Update, 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:328
Generates middleware for dropping matching updates.

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

Static email

email<C>(email: Triggers<C>, ...fns: MatchedMiddleware<C, "message" | "channel_post">): MiddlewareFn<C>

- Defined in composer.ts:479
Type parameters
- C: Context<Update, C>
Parameters
- email: Triggers<C>
- Rest ...fns: MatchedMiddleware<C, "message" | "channel_post">
Returns MiddlewareFn<C>

Private Static entity

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

- Defined in composer.ts:416
Type parameters
- C: Context<Update, C>
- T: "message" | "channel_post" | MessageSubType = "message" | "channel_post"
Parameters
- predicate: MaybeArray<string> | ((entity: MessageEntity, s: string, ctx: C) => boolean)
- Rest ...fns: readonly Middleware<MatchedContext<C, T>>[]
Returns MiddlewareFn<C>

Static entityText

entityText<C>(entityType: MaybeArray<string>, predicate: Triggers<C>, ...fns: MatchedMiddleware<C, "message" | "channel_post">): MiddlewareFn<C>

- Defined in composer.ts:450
Type parameters
- C: Context<Update, C>
Parameters
- entityType: MaybeArray<string>
- predicate: Triggers<C>
- Rest ...fns: MatchedMiddleware<C, "message" | "channel_post">
Returns MiddlewareFn<C>

Static filter

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

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

Static fork

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

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

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

Static gameQuery

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

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

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

Static groupChat

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

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

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

Static guard

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

- Defined in composer.ts:371
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<Update, 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<NarrowedContext<C, U>>>
  
  middleware to run if the predicate returns true
Returns MiddlewareFn<C>

Static hashtag

hashtag<C>(hashtag: MaybeArray<string>, ...fns: MatchedMiddleware<C, "message" | "channel_post">): MiddlewareFn<C>

- Defined in composer.ts:525
Type parameters
- C: Context<Update, C>
Parameters
- hashtag: MaybeArray<string>
- Rest ...fns: MatchedMiddleware<C, "message" | "channel_post">
Returns MiddlewareFn<C>

Static hears

hears<C>(triggers: Triggers<C>, ...fns: MatchedMiddleware<C, "text">): MiddlewareFn<C>

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

Type parameters
- C: Context<Update, C>
Parameters
- triggers: Triggers<C>
- Rest ...fns: MatchedMiddleware<C, "text">
Returns MiddlewareFn<C>

Static inlineQuery

inlineQuery<C>(triggers: Triggers<C>, ...fns: MatchedMiddleware<C, "inline_query">): MiddlewareFn<C>

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

Type parameters
- C: Context<Update, C>
Parameters
- triggers: Triggers<C>
- Rest ...fns: MatchedMiddleware<C, "inline_query">
Returns MiddlewareFn<C>

Static lazy

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

- Defined in composer.ts:267
Type parameters
- C: Context<Update, C>
Parameters
- factoryFn: (ctx: C) => Middleware<C> | Promise<Middleware<C>>
  - - (ctx: C): Middleware<C> | Promise<Middleware<C>>
    - Parameters
      - ctx: C
      Returns Middleware<C> | Promise<Middleware<C>>
Returns MiddlewareFn<C>

Static log

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

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

Private Static match

match<C, T>(triggers: readonly ((text: string, ctx: C) => null | RegExpExecArray)[], ...fns: MatchedMiddleware<C, T>): MiddlewareFn<MatchedContext<C, T>>

- Defined in composer.ts:547
Type parameters
- C: Context<Update, C>
- T: "callback_query" | "message" | "channel_post" | "inline_query" | MessageSubType
Parameters
- triggers: readonly ((text: string, ctx: C) => null | RegExpExecArray)[]
- Rest ...fns: MatchedMiddleware<C, T>
Returns MiddlewareFn<MatchedContext<C, T>>

Private Static memberStatus

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

- Defined in composer.ts:664
Type parameters
- C: Context<Update, 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: MatchedMiddleware<C, "message" | "channel_post">): MiddlewareFn<C>

- Defined in composer.ts:514
Type parameters
- C: Context<Update, C>
Parameters
- mention: MaybeArray<string>
- Rest ...fns: MatchedMiddleware<C, "message" | "channel_post">
Returns MiddlewareFn<C>

Static mount

mount<C, T>(updateType: MaybeArray<T>, ...fns: NonemptyReadonlyArray<Middleware<MatchedContext<C, T>>>): MiddlewareFn<C>

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

deprecated

use Composer.on

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

Static on

on<C, T>(updateType: MaybeArray<T>, ...fns: NonemptyReadonlyArray<Middleware<MatchedContext<C, T>>>): MiddlewareFn<C>

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

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

Static optional

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

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

Type parameters
- C: Context<Update, 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<Update>>

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

Returns MiddlewareFn<Context<Update>>

Static phone

phone<C>(number: Triggers<C>, ...fns: MatchedMiddleware<C, "message" | "channel_post">): MiddlewareFn<C>

- Defined in composer.ts:486
Type parameters
- C: Context<Update, C>
Parameters
- number: Triggers<C>
- Rest ...fns: MatchedMiddleware<C, "message" | "channel_post">
Returns MiddlewareFn<C>

Static privateChat

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

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

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

Static reply

reply(...args: [text: string, extra?: ExtraReplyMessage]): MiddlewareFn<Context<Update>>

- Defined in composer.ts:230
Parameters
- Rest ...args: [text: string, extra?: ExtraReplyMessage]
Returns MiddlewareFn<Context<Update>>

Static tap

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

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

Static textLink

textLink<C>(link: Triggers<C>, ...fns: MatchedMiddleware<C, "message" | "channel_post">): MiddlewareFn<C>

- Defined in composer.ts:500
Type parameters
- C: Context<Update, C>
Parameters
- link: Triggers<C>
- Rest ...fns: MatchedMiddleware<C, "message" | "channel_post">
Returns MiddlewareFn<C>

Static textMention

textMention<C>(mention: Triggers<C>, ...fns: MatchedMiddleware<C, "message" | "channel_post">): MiddlewareFn<C>

- Defined in composer.ts:507
Type parameters
- C: Context<Update, C>
Parameters
- mention: Triggers<C>
- Rest ...fns: MatchedMiddleware<C, "message" | "channel_post">
Returns MiddlewareFn<C>

Static unwrap

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

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

Static url

url<C>(url: Triggers<C>, ...fns: MatchedMiddleware<C, "message" | "channel_post">): MiddlewareFn<C>

- Defined in composer.ts:493
Type parameters
- C: Context<Update, C>
Parameters
- url: Triggers<C>
- Rest ...fns: MatchedMiddleware<C, "message" | "channel_post">
Returns MiddlewareFn<C>

Type parameters

C: Context

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type parameters

C: Context<Update, C>

Parameters

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

Returns Composer<C>

Properties

Private handler

Methods

action

Parameters

triggers: Triggers<C>

Rest ...fns: MatchedMiddleware<C, "callback_query">

Returns Composer<C>

cashtag

Parameters

cashtag: MaybeArray<string>

Rest ...fns: MatchedMiddleware<C, "message" | "channel_post">

Returns Composer<C>

command

Parameters

command: MaybeArray<string>

Rest ...fns: NonemptyReadonlyArray<Middleware<MatchedContext<C, "text">>>

Returns Composer<C>

drop

Parameters

predicate: Predicate<C>

Returns Composer<C>

email

Parameters

email: Triggers<C>

Rest ...fns: MatchedMiddleware<C, "message" | "channel_post">

Returns Composer<C>

Private entity

Type parameters

T: "message" | "channel_post" | MessageSubType = "message" | "channel_post"

Parameters

predicate: MaybeArray<string> | ((entity: MessageEntity, s: string, ctx: C) => boolean)

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

Returns Composer<C>

filter

Parameters

predicate: Predicate<C>

Returns Composer<C>

gameQuery

Parameters

Rest ...fns: NonemptyReadonlyArray<Middleware<NarrowedContext<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<NarrowedContext<C, U>>>

Returns Composer<C>

hashtag

Parameters

hashtag: MaybeArray<string>

Rest ...fns: MatchedMiddleware<C, "message" | "channel_post">

Returns Composer<C>

hears

Parameters

triggers: Triggers<C>

Rest ...fns: MatchedMiddleware<C, "text">

Returns Composer<C>

help

Parameters

Rest ...fns: NonemptyReadonlyArray<Middleware<MatchedContext<C, "text">>>