Optionaloptions: ClientOptionsReadonlyapiReadonlychatsReadonlyupdatesReadonlyusersStatic ReadonlycaptureStaticcaptureStaticdefaultStatic ReadonlyerrorThis symbol shall be used to install a listener for only monitoring 'error'
events. Listeners installed using this symbol are called before the regular
'error' listeners are called.
Installing a listener using this symbol does not change the behavior once an
'error' event is emitted, therefore the process will still crash if no
regular 'error' listener is installed.
Optional[captureRest...args: AnyRestAlias for emitter.on(eventName, listener).
Rest...args: any[]Use this method to add a new sticker to a set created by the bot. The format of the added sticker must match the format of the other stickers in the set. Emoji sticker sets can have up to 200 stickers. Animated and video sticker sets can have up to 50 stickers. Static sticker sets can have up to 120 stickers. Returns True on success.
Sticker set name
An object with information about the added sticker. If exactly the same sticker had already been added to the set, then the set isn't changed.
User identifier of sticker set owner
Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, True is returned. Alternatively, the user can be redirected to the specified Game URL. For this option to work, you must first create a game for your bot via BotFather and accept the terms. Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter.
OptionalcacheThe maximum amount of time in seconds that the result of the callback query may be cached client-side. Telegram apps will support caching starting in version 3.14. Defaults to 0.
Unique identifier for the query to be answered
OptionalshowIf True, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to false.
Optionaltext?: stringText of the notification. If not specified, nothing will be shown to the user, 0-200 characters
Optionalurl?: stringURL that will be opened by the user's client. If you have created a Game and accepted the conditions via @BotFather, specify the URL that opens your game - note that this will only work if the query comes from a callback_game button.
Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter.
Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, True is returned. Alternatively, the user can be redirected to the specified Game URL. For this option to work, you must first create a game for your bot via BotFather and accept the terms. Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter.
Optionalbutton?: InlineQueryResultsButtonAn object describing a button to be shown above inline query results
OptionalcacheThe maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to 300.
Unique identifier for the answered query
OptionalisPass True if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query.
OptionalnextPass the offset that a client should send in the next query with the same text to receive more results. Pass an empty string if there are no more results or if you don't support pagination. Offset length can't exceed 64 bytes.
An array of results for the inline query
Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an Update with the field pre_checkout_query. Use this method to respond to such pre-checkout queries. On success, True is returned. Note: The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent.
OptionalerrorRequired if ok is False. Error message in human readable form that explains the reason for failure to proceed with the checkout (e.g. "Sorry, somebody just bought the last of our amazing black T-shirts while you were busy filling out your payment details. Please choose a different color or garment!"). Telegram will display this message to the user.
Specify True if everything is alright (goods are available, etc.) and the bot is ready to proceed with the order. Use False if there are any problems.
Unique identifier for the query to be answered
If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the Bot API will send an Update with a shipping_query field to the bot. Use this method to reply to shipping queries. On success, True is returned.
OptionalerrorRequired if ok is False. Error message in human readable form that explains why it is impossible to complete the order (e.g. "Sorry, delivery to your desired address is unavailable'). Telegram will display this message to the user.
Pass True if delivery to the specified address is possible and False if there are any problems (for example, if delivery to the specified address is not possible)
OptionalshippingRequired if ok is True. An array of available shipping options.
Unique identifier for the query to be answered
Use this method to set the result of an interaction with a Web App and send a corresponding message on behalf of the user to the chat from which the query originated. On success, a SentWebAppMessage object is returned.
Use this method to approve a chat join get. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.
OptionalchatId: string | numberUse this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
Unique identifier for the target group or username of the target supergroup or channel (in the format @channelusername)
OptionalrevokePass True to delete all messages from the chat for the user that is being removed. If False, the user will be able to see messages in the group that were sent before the user was removed. Always True for supergroups and channels.
OptionaluntilDate when the user will be unbanned; Unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only.
Unique identifier of the target user
Use this method to ban a channel chat in a supergroup or a channel. Until the chat is unbanned, the owner of the banned chat won't be able to send messages on behalf of any of their channels. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. Returns True on success.
Use this method to close the bot instance before moving it from one local server to another. You need to delete the webhook before calling this method to ensure that the bot isn't launched again after server restart. The method will return error 429 in the first 10 minutes after the bot is launched. Returns True on success. Requires no parameters.
Use this method to close an open topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.
Use this method to close an open 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.
Use this method to copy messages of any kind. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessage, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success.
Optionalcaption?: stringNew caption for media, 0-1024 characters after entities parsing. If not specified, the original caption is kept
OptionalcaptionA list of special entities that appear in the new caption, which can be specified instead of parseMode
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
OptionaldisableSends the message silently. Users will receive a notification with no sound.
Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername)
Message identifier in the chat specified in fromChatId
OptionalmessageUnique identifier for the target message thread (topic) of the forum; for forum supergroups only
OptionalparseMode for parsing entities in the new caption. See formatting options for more details.
OptionalprotectProtects the contents of the sent message from forwarding and saving
OptionalreplyAdditional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.
OptionalreplyDescription of the message to reply to
OptionalshowPass True, if the caption must be shown above the message media. Ignored if a new caption isn't specified.
Use this method to copy messages of any kind. If some of the specified messages can't be found or copied, they are skipped. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessages, but the copied messages don't have a link to the original message. Album grouping is kept for copied messages. On success, an array of MessageId of the sent messages is returned.
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
OptionaldisableSends the messages silently. Users will receive a notification with no sound.
Unique identifier for the chat where the original messages were sent (or channel username in the format @channelusername)
A list of 1-100 identifiers of messages in the chat fromChatId to copy. The identifiers must be specified in a strictly increasing order.
OptionalmessageUnique identifier for the target message thread (topic) of the forum; for forum supergroups only
OptionalprotectProtects the contents of the sent messages from forwarding and saving
OptionalremovePass True to copy the messages without their captions
Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. The link can be revoked using the method revokeChatInviteLink. Returns the new invite link as ChatInviteLink object.
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
OptionalcreatesTrue, if users joining the chat via the link need to be approved by chat administrators. If True, memberLimit can't be specified
OptionalexpirePoint in time (Unix timestamp) when the link will expire
OptionalmemberThe maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999
Optionalname?: stringInvite link name; 0-32 characters
Use this method to create a subscription invite link for a channel chat. The bot must have the can_invite_users administrator rights. The link can be edited using the method editChatSubscriptionInviteLink or revoked using the method revokeChatInviteLink. Returns the new invite link as a ChatInviteLink object.
Unique identifier for the target channel chat or username of the target channel (in the format @channelusername)
Optionalname?: stringInvite link name; 0-32 characters
The number of seconds the subscription will be active for before the next payment. Currently, it must always be 2592000 (30 days)
The amount of Telegram Stars a user must pay initially and after each subsequent subscription period to be a member of the chat; 1-2500
Use this method to create a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns information about the created topic as a ForumTopic object.
Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
OptionaliconColor of the topic icon in RGB format. Currently, must be one of 7322096 (0x6FB9F0), 16766590 (0xFFD67E), 13338331 (0xCB86DB), 9367192 (0x8EEE98), 16749490 (0xFF93B2), or 16478047 (0xFB6F5F)
OptionaliconUnique identifier of the custom emoji shown as the topic icon. Use getForumTopicIconStickers to get all allowed custom emoji identifiers.
Topic name, 1-128 characters
Use this method to create a link for an invoice. Returns the created invoice link as String on success.
Three-letter ISO 4217 currency code, see more on currencies
Product description, 1-255 characters
OptionalisPass True if the final price depends on the shipping method
OptionalmaxThe maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass maxTipAmount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0
OptionalneedPass True if you require the user's email address to complete the order
OptionalneedPass True if you require the user's full name to complete the order
OptionalneedPass True if you require the user's phone number to complete the order
OptionalneedPass True if you require the user's shipping address to complete the order
Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.
OptionalphotoPhoto height
OptionalphotoPhoto size in bytes
OptionalphotoURL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service.
OptionalphotoPhoto width
Price breakdown, a list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)
OptionalproviderData about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider.
OptionalproviderPayment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars.
OptionalsendPass True if the user's email address should be sent to the provider
OptionalsendPass True if the user's phone number should be sent to the provider
OptionalsuggestedAn array of suggested amounts of tips in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed maxTipAmount.
Product name, 1-32 characters
Use this method to create a new sticker set owned by a user. The bot will be able to edit the sticker set thus created. Returns True on success.
Short name of sticker set, to be used in t.me/addstickers/ URLs (e.g., animals). Can contain only English letters, digits and underscores. Must begin with a letter, can't contain consecutive underscores and must end in "by<bot_username>". <bot_username> is case insensitive. 1-64 characters.
OptionalneedsPass True if stickers in the sticker set must be repainted to the color of text when used in messages, the accent color if used as emoji status, white on chat photos, or another appropriate color based on context; for custom emoji sticker sets only
OptionalstickerType of stickers in the set, pass “regular”, “mask”, or “custom_emoji”. By default, a regular sticker set is created.
A list of 1-50 initial stickers to be added to the sticker set
Sticker set title, 1-64 characters
User identifier of created sticker set owner
Use this method to decline a chat join get. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.
Use this method to delete a chat photo. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set ly returned in getChat requests to check if the bot can use this method. Returns True on success.
OptionalchatId: string | numberUse this method to delete a forum topic along with all its messages in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_delete_messages administrator rights. Returns True on success.
Use this method to delete a message, including service messages, with the following limitations:
Use this method to delete the list of the bot's commands for the given scope and user language. After deletion, higher level commands will be shown to affected users. Returns True on success.
Optionalscope: BotCommandScopeOptionallanguageCode: stringUse this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the edited invite link as a ChatInviteLink object.
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
OptionalcreatesTrue, if users joining the chat via the link need to be approved by chat administrators. If True, memberLimit can't be specified
OptionalexpirePoint in time (Unix timestamp) when the link will expire
The invite link to edit
OptionalmemberThe maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999
Optionalname?: stringInvite link name; 0-32 characters
Use this method to edit a subscription invite link created by the bot. The bot must have the can_invite_users administrator rights. Returns the edited invite link as a ChatInviteLink object.
Unique identifier for the target channel chat or username of the target channel (in the format @channelusername)
The invite link to edit
Optionalname?: stringInvite link name; 0-32 characters
Use this method to edit name and icon of a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.
Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
OptionaliconNew unique identifier of the custom emoji shown as the topic icon. Use getForumTopicIconStickers to get all allowed custom emoji identifiers. Pass an empty string to remove the icon. If not specified, the current icon will be kept
Unique identifier for the target message thread of the forum topic
Optionalname?: stringNew topic name, 0-128 characters. If not specified or empty, the current name of the topic will be kept
Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights. Returns True on success.
Use this method to edit captions of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.
OptionalbusinessUnique identifier of the business connection on behalf of which the message to be edited was sent
Optionalcaption?: stringNew caption of the message, 0-1024 characters after entities parsing
OptionalcaptionA list of special entities that appear in the caption, which can be specified instead of parseMode
OptionalchatRequired if inlineMessageId is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)
OptionalinlineRequired if chatId and messageId are not specified. Identifier of the inline message
OptionalmessageRequired if inlineMessageId is not specified. Identifier of the message to edit
OptionalparseMode for parsing entities in the message caption. See formatting options for more details.
OptionalreplyAn object for an inline keyboard.
OptionalshowPass True, if the caption must be shown above the message media. Supported only for animation, photo and video messages.
Use this method to edit live location messages. A location can be edited until its live_period expires or editing is explicitly disabled by a call to stopMessageLiveLocation. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.
OptionalbusinessUnique identifier of the business connection on behalf of which the message to be edited was sent
OptionalchatRequired if inlineMessageId is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)
Optionalheading?: numberThe direction in which user is moving, in degrees; 1-360. For active live locations only.
OptionalhorizontalThe radius of uncertainty for the location, measured in meters; 0-1500
OptionalinlineRequired if chatId and messageId are not specified. Identifier of the inline message
Latitude of new location
OptionalliveNew period in seconds during which the location can be updated, starting from the message send date. If 0x7FFFFFFF is specified, then the location can be updated forever. Otherwise, the new value must not exceed the current livePeriod by more than a day, and the live location expiration date must remain within the next 90 days. If not specified, then livePeriod remains unchanged
Longitude of new location
OptionalmessageRequired if inlineMessageId is not specified. Identifier of the message to edit
OptionalproximityThe maximum distance for proximity alerts about approaching another chat member, in meters. For sent live locations only.
OptionalreplyAn object for a new inline keyboard.
Use this method to edit animation, audio, document, photo, or video messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.
OptionalbusinessUnique identifier of the business connection on behalf of which the message to be edited was sent
OptionalchatRequired if inlineMessageId is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)
OptionalinlineRequired if chatId and messageId are not specified. Identifier of the inline message
An object for a new media content of the message
OptionalmessageRequired if inlineMessageId is not specified. Identifier of the message to edit
OptionalreplyAn object for a new inline keyboard.
Use this method to edit only the reply markup of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.
OptionalbusinessUnique identifier of the business connection on behalf of which the message to be edited was sent
OptionalchatRequired if inlineMessageId is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)
OptionalinlineRequired if chatId and messageId are not specified. Identifier of the inline message
OptionalmessageRequired if inlineMessageId is not specified. Identifier of the message to edit
OptionalreplyAn object for an inline keyboard.
Use this method to edit text and game messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.
OptionalbusinessUnique identifier of the business connection on behalf of which the message to be edited was sent
OptionalchatRequired if inlineMessageId is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)
Optionalentities?: MessageEntity[]A list of special entities that appear in message text, which can be specified instead of parseMode
OptionalinlineRequired if chatId and messageId are not specified. Identifier of the inline message
OptionallinkLink preview generation options for the message
OptionalmessageRequired if inlineMessageId is not specified. Identifier of the message to edit
OptionalparseMode for parsing entities in the message text. See formatting options for more details.
OptionalreplyAn object for an inline keyboard.
New text of the message, 1-4096 characters after entities parsing
Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments
to each.
Returns true if the event had listeners, false otherwise.
const EventEmitter = require('events');
const myEmitter = new EventEmitter();
// First listener
myEmitter.on('event', function firstListener() {
console.log('Helloooo! first listener');
});
// Second listener
myEmitter.on('event', function secondListener(arg1, arg2) {
console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
});
// Third listener
myEmitter.on('event', function thirdListener(...args) {
const parameters = args.join(', ');
console.log(`event with parameters ${parameters} in third listener`);
});
console.log(myEmitter.listeners('event'));
myEmitter.emit('event', 1, 2, 3, 4, 5);
// Prints:
// [
// [Function: firstListener],
// [Function: secondListener],
// [Function: thirdListener]
// ]
// Helloooo! first listener
// event with parameters 1, 2 in second listener
// event with parameters 1, 2, 3, 4, 5 in third listener
Rest...args: AnyRestReturns an array listing the events for which the emitter has registered
listeners. The values in the array are strings or Symbols.
const EventEmitter = require('events');
const myEE = new EventEmitter();
myEE.on('foo', () => {});
myEE.on('bar', () => {});
const sym = Symbol('symbol');
myEE.on(sym, () => {});
console.log(myEE.eventNames());
// Prints: [ 'foo', 'bar', Symbol(symbol) ]
Use this method to generate a new primary invite link for a chat; any previously generated primary link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the new invite link as String on success.
Note: Each administrator in a chat generates their own invite links. Bots can't use invite links generated by other administrators. If you want your bot to work with invite links, it will need to generate its own link using exportChatInviteLink or by calling the getChat method. If your bot needs to generate a new primary invite link replacing its previous one, use exportChatInviteLink again.
OptionalchatId: string | numberUse this method to forward messages of any kind. Service messages and messages with protected content can't be forwarded. On success, the sent Message is returned.
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
OptionaldisableSends the message silently. Users will receive a notification with no sound.
Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername)
Message identifier in the chat specified in fromChatId
OptionalmessageUnique identifier for the target message thread (topic) of the forum; for forum supergroups only
OptionalprotectProtects the contents of the forwarded message from forwarding and saving
Use this method to forward multiple messages of any kind. If some of the specified messages can't be found or forwarded, they are skipped. Service messages and messages with protected content can't be forwarded. Album grouping is kept for forwarded messages. On success, an array of MessageId of the sent messages is returned.
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
OptionaldisableSends the messages silently. Users will receive a notification with no sound.
Unique identifier for the chat where the original messages were sent (or channel username in the format @channelusername)
A list of 1-100 identifiers of messages in the chat fromChatId to forward. The identifiers must be specified in a strictly increasing order.
OptionalmessageUnique identifier for the target message thread (topic) of the forum; for forum supergroups only
OptionalprotectProtects the contents of the forwarded messages from forwarding and saving
Use this method to get information about the connection of the bot with a business account. Returns a BusinessConnection object on success.
Use this method to get up to date information about the chat (current name of the user for one-on-one conversations, current username of a user, group or channel, etc.). Returns a Chat object on success.
Use this method to get a list of administrators in a chat, which aren't bots. Returns an Array of ChatMember objects.
Use this method to get information about a member of a chat. The method is only guaranteed to work for other users if the bot is an administrator in the chat. Returns a ChatMember object on success.
Use this method to get the current value of the bot's menu button in a private chat, or the default menu button. Returns MenuButton on success.
OptionalchatId: string | numberUse this method to get basic information about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a File object is returned. The file can then be downloaded via the link https://api.telegram.org/file/bot
Note: This function may not preserve the original file name and MIME type. You should save the file's MIME type and name (if available) when the File object is received.
Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game. Returns an Array of GameHighScore objects.
This method will currently return scores for the target user, plus two of their closest neighbors on each side. Will also return the top three users if the user and their neighbors are not among them. Please note that this behavior is subject to change.
OptionalchatRequired if inlineMessageId is not specified. Unique identifier for the target chat
OptionalinlineRequired if chatId and messageId are not specified. Identifier of the inline message
OptionalmessageRequired if inlineMessageId is not specified. Identifier of the sent message
Target user id
Returns the current max listener value for the EventEmitter which is either
set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.
A simple method for testing your bot's authentication token. Requires no parameters. Returns basic information about the bot in form of a User object.
Use this method to get the current list of the bot's commands for the given scope and user language. Returns an Array of BotCommand objects. If commands aren't set, an empty list is returned.
Optionalscope: BotCommandScopeOptionallanguageCode: stringUse this method to get the current default administrator rights of the bot. Returns ChatAdministratorRights on success.
OptionalforChannels: booleanReturns the bot's Telegram Star transactions in chronological order. On success, returns a StarTransactions object.
Optionaloffset: numberOptionallimit: numberUse this method to get a sticker set. On success, a StickerSet object is returned.
Use this method to receive incoming updates using long polling (wiki). Returns an Array of Update objects.
Notes
Optionalparams: { OptionalallowedA list of the update types you want your bot to receive. For example, specify ["message", "edited_channel_post", "callback_query"] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member, message_reaction, and message_reaction_count (default). If not specified, the previous setting will be used.
Please note that this parameter doesn't affect updates created before the call to the getUpdates, so unwanted updates may be received for a short period of time.
Optionallimit?: numberLimits the number of updates to be retrieved. Values between 1-100 are accepted. Defaults to 100.
Optionaloffset?: numberIdentifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as getUpdates is called with an offset higher than its update_id. The negative offset can be specified to retrieve updates starting from -offset update from the end of the updates queue. All previous updates will be forgotten.
Optionaltimeout?: numberTimeout in seconds for long polling. Defaults to 0, i.e. usual short polling. Should be positive, short polling should be used for testing purposes only.
Use this method to get the list of boosts added to a chat by a user. Requires administrator rights in the chat. Returns a UserChatBoosts object.
Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object.
Optionallimit?: numberLimits the number of photos to be retrieved. Values between 1-100 are accepted. Defaults to 100.
Optionaloffset?: numberSequential number of the first photo to be returned. By default, all photos are returned.
Unique identifier of the target user
Use this method to get current webhook status. Requires no parameters. On success, returns a WebhookInfo object. If the bot is using getUpdates, will return an object with the url field empty.
Use this method to hide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically closed if it was open. Returns True on success.
Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
Unique identifier for the target group or username of the target supergroup or channel (in the format @channelusername)
OptionalrevokePass True to delete all messages from the chat for the user that is being removed. If False, the user will be able to see messages in the group that were sent before the user was removed. Always True for supergroups and channels.
OptionaluntilDate when the user will be unbanned; Unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only.
Unique identifier of the target user
Returns the number of listeners listening to the event named eventName.
If listener is provided, it will return how many times the listener
is found in the list of the listeners of the event.
The name of the event being listened for
Optionallistener: FunctionThe event handler function
Returns a copy of the array of listeners for the event named eventName.
server.on('connection', (stream) => {
console.log('someone connected!');
});
console.log(util.inspect(server.listeners('connection')));
// Prints: [ [Function] ]
Use this method to log out from the cloud Bot API server before launching the bot locally. You must log out the bot before running it locally, otherwise there is no guarantee that the bot will receive updates. After a successful call, you can immediately log in on a local server, but will not be able to log in back to the cloud Bot API server for 10 minutes. Returns True on success. Requires no parameters.
Alias for emitter.removeListener().
Rest...args: any[]Adds a typed listener for the specified event.
The event name.
The listener function.
The ManagerEvents instance.
Adds a typed one-time listener for the specified event.
The event name.
The listener function.
The ManagerEvents instance.
Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' admin right in a supergroup or 'can_edit_messages' admin right in a channel. Returns True on success.
OptionalbusinessUnique identifier of the business connection on behalf of which the message will be pinned
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
OptionaldisablePass True if it is not necessary to send a notification to all chat members about the new pinned message. Notifications are always disabled in channels and private chats.
Identifier of a message to pin
Adds the listener function to the beginning of the listeners array for the
event named eventName. No checks are made to see if the listener has
already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple
times.
server.prependListener('connection', (stream) => {
console.log('someone connected!');
});
Returns a reference to the EventEmitter, so that calls can be chained.
The name of the event.
The callback function
Rest...args: any[]Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this
listener is removed, and then invoked.
server.prependOnceListener('connection', (stream) => {
console.log('Ah, we have our first user!');
});
Returns a reference to the EventEmitter, so that calls can be chained.
The name of the event.
The callback function
Rest...args: any[]Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Pass False for all boolean parameters to demote a user. Returns True on success.
Returns a copy of the array of listeners for the event named eventName,
including any wrappers (such as those created by .once()).
const emitter = new EventEmitter();
emitter.once('log', () => console.log('log once'));
// Returns a new Array with a function `onceWrapper` which has a property
// `listener` which contains the original listener bound above
const listeners = emitter.rawListeners('log');
const logFnWrapper = listeners[0];
// Logs "log once" to the console and does not unbind the `once` event
logFnWrapper.listener();
// Logs "log once" to the console and removes the listener
logFnWrapper();
emitter.on('log', () => console.log('log persistently'));
// Will return a new Array with a single function bound by `.on()` above
const newListeners = emitter.rawListeners('log');
// Logs "log persistently" twice
newListeners[0]();
emitter.emit('log');
Removes all listeners, or those of the specified eventName.
It is bad practice to remove listeners added elsewhere in the code,
particularly when the EventEmitter instance was created by some other
component or module (e.g. sockets or file streams).
Returns a reference to the EventEmitter, so that calls can be chained.
Optionalevent: string | symbolRemoves the specified listener from the listener array for the event namedeventName.
const callback = (stream) => {
console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);
removeListener() will remove, at most, one instance of a listener from the
listener array. If any single listener has been added multiple times to the
listener array for the specified eventName, then removeListener() must be
called multiple times to remove each instance.
Once an event is emitted, all listeners attached to it at the
time of emitting are called in order. This implies that anyremoveListener() or removeAllListeners() calls after emitting and before the last listener finishes execution
will not remove them fromemit() in progress. Subsequent events behave as expected.
const myEmitter = new MyEmitter();
const callbackA = () => {
console.log('A');
myEmitter.removeListener('event', callbackB);
};
const callbackB = () => {
console.log('B');
};
myEmitter.on('event', callbackA);
myEmitter.on('event', callbackB);
// callbackA removes listener callbackB but it will still be called.
// Internal listener array at time of emit [callbackA, callbackB]
myEmitter.emit('event');
// Prints:
// A
// B
// callbackB is now removed.
// Internal listener array [callbackA]
myEmitter.emit('event');
// Prints:
// A
Because listeners are managed using an internal array, calling this will
change the position indices of any listener registered after the listener
being removed. This will not impact the order in which listeners are called,
but it means that any copies of the listener array as returned by
the emitter.listeners() method will need to be recreated.
When a single function has been added as a handler multiple times for a single
event (as in the example below), removeListener() will remove the most
recently added instance. In the example the once('ping')listener is removed:
const ee = new EventEmitter();
function pong() {
console.log('pong');
}
ee.on('ping', pong);
ee.once('ping', pong);
ee.removeListener('ping', pong);
ee.emit('ping');
ee.emit('ping');
Returns a reference to the EventEmitter, so that calls can be chained.
Rest...args: any[]Use this method to reopen a closed topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.
Use this method to reopen a closed 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically unhidden if it was hidden. Returns True on success.
Use this method to replace an existing sticker in a sticker set with a new one. The method is equivalent to calling deleteStickerFromSet, then addStickerToSet, then setStickerPositionInSet. Returns True on success.
Sticker set name
File identifier of the replaced sticker
An object with information about the added sticker. If exactly the same sticker had already been added to the set, then the set remains unchanged.:x
User identifier of the sticker set owner
Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate administrator rights. Pass True for all permissions to lift restrictions from a user. Returns True on success.
Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the revoked invite link as ChatInviteLink object.
OptionalchatId: string | numberUse this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent Message is returned. Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future.
Animation to send. Pass a fileId as String to send an animation that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an animation from the Internet, or upload a new animation using multipart/form-data.
OptionalbusinessUnique identifier of the business connection on behalf of which the message will be sent
Optionalcaption?: stringAnimation caption (may also be used when resending animation by fileId), 0-1024 characters after entities parsing
OptionalcaptionA list of special entities that appear in the caption, which can be specified instead of parseMode
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
OptionaldisableSends the message silently. Users will receive a notification with no sound.
Optionalduration?: numberDuration of sent animation in seconds
OptionalhasPass True if the animation needs to be covered with a spoiler animation
Optionalheight?: numberAnimation height
OptionalmessageUnique identifier of the message effect to be added to the message; for private chats only
OptionalmessageUnique identifier for the target message thread (topic) of the forum; for forum supergroups only
OptionalparseMode for parsing entities in the animation caption. See formatting options for more details.
OptionalprotectProtects the contents of the sent message from forwarding and saving
OptionalreplyAdditional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
OptionalreplyDescription of the message to reply to
OptionalshowPass True, if the caption must be shown above the message media
Optionalthumbnail?: Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass "attach://<file_attach_name>" if the thumbnail was uploaded using multipart/form-data under <file_attach_name>.
Optionalwidth?: numberAnimation width
Use this method to send audio files, if you want Telegram clients to display them in the music player. Your audio must be in the .MP3 or .M4A format. On success, the sent Message is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future.
For sending voice messages, use the sendVoice method instead.
Audio file to send. Pass a fileId as String to send an audio file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an audio file from the Internet, or upload a new one using multipart/form-data.
OptionalbusinessUnique identifier of the business connection on behalf of which the message will be sent
Optionalcaption?: stringAudio caption, 0-1024 characters after entities parsing
OptionalcaptionA list of special entities that appear in the caption, which can be specified instead of parseMode
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
OptionaldisableSends the message silently. Users will receive a notification with no sound.
Optionalduration?: numberDuration of the audio in seconds
OptionalmessageUnique identifier of the message effect to be added to the message; for private chats only
OptionalmessageUnique identifier for the target message thread (topic) of the forum; for forum supergroups only
OptionalparseMode for parsing entities in the audio caption. See formatting options for more details.
Optionalperformer?: stringPerformer
OptionalprotectProtects the contents of the sent message from forwarding and saving
OptionalreplyAdditional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
OptionalreplyDescription of the message to reply to
Optionalthumbnail?: Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass "attach://<file_attach_name>" if the thumbnail was uploaded using multipart/form-data under <file_attach_name>.
Optionaltitle?: stringTrack name
Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Returns True on success.
Example: The ImageBot needs some time to process a request and upload the image. Instead of sending a text message along the lines of "Retrieving image, please wait...", the bot may use sendChatAction with action = upload_photo. The user will see a "sending photo" status for the bot.
We only recommend using this method when a response from the bot will take a noticeable amount of time to arrive.
Type of action to broadcast. Choose one, depending on what the user is about to receive: typing for text messages, upload_photo for photos, record_video or upload_video for videos, record_voice or upload_voice for voice notes, upload_document for general files, choose_sticker for stickers, find_location for location data, record_video_note or upload_video_note for video notes.
OptionalbusinessUnique identifier of the business connection on behalf of which the action will be sent
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
OptionalmessageUnique identifier for the target message thread; for supergroups only
Use this method to send phone contacts. On success, the sent Message is returned.
OptionalbusinessUnique identifier of the business connection on behalf of which the message will be sent
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
OptionaldisableSends the message silently. Users will receive a notification with no sound.
Contact's first name
OptionallastContact's last name
OptionalmessageUnique identifier of the message effect to be added to the message; for private chats only
OptionalmessageUnique identifier for the target message thread (topic) of the forum; for forum supergroups only
Contact's phone number
OptionalprotectProtects the contents of the sent message from forwarding and saving
OptionalreplyAdditional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
OptionalreplyDescription of the message to reply to
Optionalvcard?: stringAdditional data about the contact in the form of a vCard, 0-2048 bytes
Use this method to send an animated emoji that will display a random value. On success, the sent Message is returned.
OptionalbusinessUnique identifier of the business connection on behalf of which the message will be sent
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
OptionaldisableSends the message silently. Users will receive a notification with no sound.
Optionalemoji?: stringEmoji on which the dice throw animation is based. Currently, must be one of "🎲", "🎯", "🏀", "⚽", "🎳", or "🎰". Dice can have values 1-6 for "🎲", "🎯" and "🎳", values 1-5 for "🏀" and "⚽", and values 1-64 for "🎰". Defaults to "🎲"
OptionalmessageUnique identifier of the message effect to be added to the message; for private chats only
OptionalmessageUnique identifier for the target message thread (topic) of the forum; for forum supergroups only
OptionalprotectProtects the contents of the sent message from forwarding
OptionalreplyAdditional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
OptionalreplyDescription of the message to reply to
Use this method to send general files. On success, the sent Message is returned. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future.
OptionalbusinessUnique identifier of the business connection on behalf of which the message will be sent
Optionalcaption?: stringDocument caption (may also be used when resending documents by fileId), 0-1024 characters after entities parsing
OptionalcaptionA list of special entities that appear in the caption, which can be specified instead of parseMode
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
OptionaldisableDisables automatic server-side content type detection for files uploaded using multipart/form-data. Always true, if the document is sent as part of an album.
OptionaldisableSends the message silently. Users will receive a notification with no sound.
File to send. Pass a fileId as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data.
OptionalmessageUnique identifier of the message effect to be added to the message; for private chats only
OptionalmessageUnique identifier for the target message thread (topic) of the forum; for forum supergroups only
OptionalparseMode for parsing entities in the document caption. See formatting options for more details.
OptionalprotectProtects the contents of the sent message from forwarding and saving
OptionalreplyAdditional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
OptionalreplyDescription of the message to reply to
Optionalthumbnail?: Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass "attach://<file_attach_name>" if the thumbnail was uploaded using multipart/form-data under <file_attach_name>.
Use this method to send a game. On success, the sent Message is returned.
OptionalbusinessUnique identifier of the business connection on behalf of which the message will be sent
Unique identifier for the target chat
OptionaldisableSends the message silently. Users will receive a notification with no sound.
Short name of the game, serves as the unique identifier for the game. Set up your games via BotFather.
OptionalmessageUnique identifier of the message effect to be added to the message; for private chats only
OptionalmessageUnique identifier for the target message thread (topic) of the forum; for forum supergroups only
OptionalprotectProtects the contents of the sent message from forwarding and saving
OptionalreplyAn object for an inline keyboard. If empty, one 'Play game_title' button will be shown. If not empty, the first button must launch the game.
OptionalreplyDescription of the message to reply to
Use this method to send invoices. On success, the sent Message is returned.
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
Three-letter ISO 4217 currency code, see more on currencies. Pass “XTR” for payments in Telegram Stars.
Product description, 1-255 characters
OptionaldisableSends the message silently. Users will receive a notification with no sound.
OptionalisPass True if the final price depends on the shipping method. Ignored for payments in Telegram Stars.
OptionalmaxThe maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass maxTipAmount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in Telegram Stars.
OptionalmessageUnique identifier of the message effect to be added to the message; for private chats only
OptionalmessageUnique identifier for the target message thread (topic) of the forum; for forum supergroups only
OptionalneedPass True if you require the user's email address to complete the order. Ignored for payments in Telegram Stars.
OptionalneedPass True if you require the user's full name to complete the order. Ignored for payments in Telegram Stars.
OptionalneedPass True if you require the user's phone number to complete the order. Ignored for payments in Telegram Stars.
OptionalneedPass True if you require the user's shipping address to complete the order. Ignored for payments in Telegram Stars.
Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.
OptionalphotoPhoto height
OptionalphotoPhoto size in bytes
OptionalphotoURL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for.
OptionalphotoPhoto width
Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in Telegram Stars.
OptionalprotectProtects the contents of the sent message from forwarding and saving
OptionalproviderData about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider.
OptionalproviderPayment provider token, obtained via BotFather. Pass an empty string for payments in Telegram Stars.
OptionalreplyAn object for an inline keyboard. If empty, one 'Pay total price' button will be shown. If not empty, the first button must be a Pay button.
OptionalreplyDescription of the message to reply to
OptionalsendPass True if the user's email address should be sent to provider. Ignored for payments in Telegram Stars.
OptionalsendPass True if the user's phone number should be sent to provider. Ignored for payments in Telegram Stars.
OptionalstartUnique deep-linking parameter. If left empty, forwarded copies of the sent message will have a Pay button, allowing multiple users to pay directly from the forwarded message, using the same invoice. If non-empty, forwarded copies of the sent message will have a URL button with a deep link to the bot (instead of a Pay button), with the value used as the start parameter
OptionalsuggestedAn array of suggested amounts of tips in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed maxTipAmount.
Product name, 1-32 characters
Use this method to send point on the map. On success, the sent Message is returned.
OptionalbusinessUnique identifier of the business connection on behalf of which the message will be sent
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
OptionaldisableSends the message silently. Users will receive a notification with no sound.
Optionalheading?: numberThe direction in which user is moving, in degrees; 1-360. For active live locations only.
OptionalhorizontalThe radius of uncertainty for the location, measured in meters; 0-1500
Latitude of the location
OptionallivePeriod in seconds during which the location will be updated (see Live Locations, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely.
Longitude of the location
OptionalmessageUnique identifier of the message effect to be added to the message; for private chats only
OptionalmessageUnique identifier for the target message thread (topic) of the forum; for forum supergroups only
OptionalprotectProtects the contents of the sent message from forwarding and saving
OptionalproximityThe maximum distance for proximity alerts about approaching another chat member, in meters. For sent live locations only.
OptionalreplyAdditional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
OptionalreplyDescription of the message to reply to
Use this method to send a group of photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. On success, an array of Messages that were sent is returned.
OptionalbusinessUnique identifier of the business connection on behalf of which the message will be sent
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
OptionaldisableSends the messages silently. Users will receive a notification with no sound.
OptionalmessageUnique identifier of the message effect to be added to the message; for private chats only
OptionalmessageUnique identifier for the target message thread (topic) of the forum; for forum supergroups only
OptionalprotectProtects the contents of the sent messages from forwarding and saving
OptionalreplyDescription of the message to reply to
Use this method to send text messages. On success, the sent Message is returned.
OptionalbusinessUnique identifier of the business connection on behalf of which the message will be sent
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
OptionaldisableSends the message silently. Users will receive a notification with no sound.
Optionalentities?: MessageEntity[]A list of special entities that appear in message text, which can be specified instead of parseMode
OptionallinkLink preview generation options for the message
OptionalmessageUnique identifier of the message effect to be added to the message; for private chats only
OptionalmessageUnique identifier for the target message thread (topic) of the forum; for forum supergroups only
OptionalparseMode for parsing entities in the message text. See formatting options for more details.
OptionalprotectProtects the contents of the sent message from forwarding and saving
OptionalreplyAdditional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
OptionalreplyDescription of the message to reply to
Text of the message to be sent, 1-4096 characters after entities parsing
Use this method to send paid media to channel chats. On success, the sent Message is returned.
OptionalbusinessUnique identifier of the business connection on behalf of which the message will be sent
Optionalcaption?: stringMedia caption, 0-1024 characters after entities parsing
OptionalcaptionA list of special entities that appear in the caption, which can be specified instead of parseMode
Unique identifier for the target chat or username of the target channel (in the format @channelusername). If the chat is a channel, all Telegram Star proceeds from this media will be credited to the chat's balance. Otherwise, they will be credited to the bot's balance
OptionaldisableSends the message silently. Users will receive a notification with no sound.
An array describing the media to be sent; up to 10 items
OptionalparseMode for parsing entities in the media caption. See formatting options for more details.
Optionalpayload?: stringBot-defined paid media payload, 0-128 bytes. This will not be displayed to the user, use it for your internal processes.
OptionalprotectProtects the contents of the sent message from forwarding and saving
OptionalreplyAdditional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user
OptionalreplyDescription of the message to reply to
OptionalshowPass True, if the caption must be shown above the message media
The number of Telegram Stars that must be paid to buy access to the media; 1-2500
Use this method to send photos. On success, the sent Message is returned.
OptionalbusinessUnique identifier of the business connection on behalf of which the message will be sent
Optionalcaption?: stringPhoto caption (may also be used when resending photos by fileId), 0-1024 characters after entities parsing
OptionalcaptionA list of special entities that appear in the caption, which can be specified instead of parseMode
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
OptionaldisableSends the message silently. Users will receive a notification with no sound.
OptionalhasPass True if the photo needs to be covered with a spoiler animation
OptionalmessageUnique identifier of the message effect to be added to the message; for private chats only
OptionalmessageUnique identifier for the target message thread (topic) of the forum; for forum supergroups only
OptionalparseMode for parsing entities in the photo caption. See formatting options for more details.
Photo to send. Pass a fileId as String to send a photo that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a photo from the Internet, or upload a new photo using multipart/form-data. The photo must be at most 10 MB in size. The photo's width and height must not exceed 10000 in total. Width and height ratio must be at most 20.
OptionalprotectProtects the contents of the sent message from forwarding and saving
OptionalreplyAdditional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
OptionalreplyDescription of the message to reply to
OptionalshowPass True, if the caption must be shown above the message media
Use this method to send a native poll. On success, the sent Message is returned.
OptionalallowsTrue, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to False
OptionalbusinessUnique identifier of the business connection on behalf of which the message will be sent
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
OptionalclosePoint in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 600 seconds in the future. Can't be used together with openPeriod.
Optionalcorrect0-based identifier of the correct answer option, required for polls in quiz mode
OptionaldisableSends the message silently. Users will receive a notification with no sound.
Optionalexplanation?: stringText that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, 0-200 characters with at most 2 line feeds after entities parsing
OptionalexplanationA list of special entities that appear in the poll explanation. It can be specified instead of explanationParseMode
OptionalexplanationMode for parsing entities in the explanation. See formatting options for more details.
OptionalisTrue, if the poll needs to be anonymous, defaults to True
OptionalisPass True if the poll needs to be immediately closed. This can be useful for poll preview.
OptionalmessageUnique identifier of the message effect to be added to the message; for private chats only
OptionalmessageUnique identifier for the target message thread (topic) of the forum; for forum supergroups only
OptionalopenAmount of time in seconds the poll will be active after creation, 5-600. Can't be used together with closeDate.
A list of 2-10 answer options
OptionalprotectProtects the contents of the sent message from forwarding and saving
Poll question, 1-300 characters
OptionalquestionA list of special entities that appear in the poll question. It can be specified instead of questionParseMode
OptionalquestionMode for parsing entities in the question. See formatting options for more details. Currently, only custom emoji entities are allowed
OptionalreplyAdditional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
OptionalreplyDescription of the message to reply to
Optionaltype?: "quiz" | "regular"Poll type, “quiz” or “regular”, defaults to “regular”
Use this method to send static .WEBP, animated .TGS, or video .WEBM stickers. On success, the sent Message is returned.
OptionalbusinessUnique identifier of the business connection on behalf of which the message will be sent
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
OptionaldisableSends the message silently. Users will receive a notification with no sound.
Optionalemoji?: stringEmoji associated with the sticker; only for just uploaded stickers
OptionalmessageUnique identifier of the message effect to be added to the message; for private chats only
OptionalmessageUnique identifier for the target message thread (topic) of the forum; for forum supergroups only
OptionalprotectProtects the contents of the sent message from forwarding and saving
OptionalreplyAdditional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
OptionalreplyDescription of the message to reply to
Sticker to send. Pass a fileId as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a .WEBP sticker from the Internet, or upload a new .WEBP, .TGS, or .WEBM sticker using multipart/form-data. Video and animated stickers can't be sent via an HTTP URL.
Use this method to send information about a venue. On success, the sent Message is returned.
Address of the venue
OptionalbusinessUnique identifier of the business connection on behalf of which the message will be sent
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
OptionaldisableSends the message silently. Users will receive a notification with no sound.
OptionalfoursquareFoursquare identifier of the venue
OptionalfoursquareFoursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)
OptionalgoogleGoogle Places identifier of the venue
OptionalgoogleGoogle Places type of the venue. (See supported types.)
Latitude of the venue
Longitude of the venue
OptionalmessageUnique identifier of the message effect to be added to the message; for private chats only
OptionalmessageUnique identifier for the target message thread (topic) of the forum; for forum supergroups only
OptionalprotectProtects the contents of the sent message from forwarding and saving
OptionalreplyAdditional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
OptionalreplyDescription of the message to reply to
Name of the venue
Use this method to send video files, Telegram clients support MPEG4 videos (other formats may be sent as Document). On success, the sent Message is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future.
OptionalbusinessUnique identifier of the business connection on behalf of which the message will be sent
Optionalcaption?: stringVideo caption (may also be used when resending videos by fileId), 0-1024 characters after entities parsing
OptionalcaptionA list of special entities that appear in the caption, which can be specified instead of parseMode
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
OptionaldisableSends the message silently. Users will receive a notification with no sound.
Optionalduration?: numberDuration of sent video in seconds
OptionalhasPass True if the video needs to be covered with a spoiler animation
Optionalheight?: numberVideo height
OptionalmessageUnique identifier of the message effect to be added to the message; for private chats only
OptionalmessageUnique identifier for the target message thread (topic) of the forum; for forum supergroups only
OptionalparseMode for parsing entities in the video caption. See formatting options for more details.
OptionalprotectProtects the contents of the sent message from forwarding and saving
OptionalreplyAdditional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
OptionalreplyDescription of the message to reply to
OptionalshowPass True, if the caption must be shown above the message media
OptionalsupportsPass True if the uploaded video is suitable for streaming
Optionalthumbnail?: Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass "attach://<file_attach_name>" if the thumbnail was uploaded using multipart/form-data under <file_attach_name>.
Video to send. Pass a fileId as String to send a video that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a video from the Internet, or upload a new video using multipart/form-data.
Optionalwidth?: numberVideo width
Use this method to send video messages. On success, the sent Message is returned. As of v.4.0, Telegram clients support rounded square MPEG4 videos of up to 1 minute long.
OptionalbusinessUnique identifier of the business connection on behalf of which the message will be sent
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
OptionaldisableSends the message silently. Users will receive a notification with no sound.
Optionalduration?: numberDuration of sent video in seconds
Optionallength?: numberVideo width and height, i.e. diameter of the video message
OptionalmessageUnique identifier of the message effect to be added to the message; for private chats only
OptionalmessageUnique identifier for the target message thread (topic) of the forum; for forum supergroups only
OptionalprotectProtects the contents of the sent message from forwarding and saving
OptionalreplyAdditional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
OptionalreplyDescription of the message to reply to
Optionalthumbnail?: Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass "attach://<file_attach_name>" if the thumbnail was uploaded using multipart/form-data under <file_attach_name>.
Video note to send. Pass a fileId as String to send a video note that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data.. Sending video notes by a URL is currently unsupported
Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS, or in .MP3 format, or in .M4A format (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.
OptionalbusinessUnique identifier of the business connection on behalf of which the message will be sent
Optionalcaption?: stringVoice message caption, 0-1024 characters after entities parsing
OptionalcaptionA list of special entities that appear in the caption, which can be specified instead of parseMode
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
OptionaldisableSends the message silently. Users will receive a notification with no sound.
Optionalduration?: numberDuration of the voice message in seconds
OptionalmessageUnique identifier of the message effect to be added to the message; for private chats only
OptionalmessageUnique identifier for the target message thread (topic) of the forum; for forum supergroups only
OptionalparseMode for parsing entities in the voice message caption. See formatting options for more details.
OptionalprotectProtects the contents of the sent message from forwarding and saving
OptionalreplyAdditional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
OptionalreplyDescription of the message to reply to
Audio file to send. Pass a fileId as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data.
Use this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns True on success.
Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)
New custom title for the administrator; 0-16 characters, emoji are not allowed
Unique identifier of the target user
Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
Optionaldescription: stringUse this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the can_restrict_members administrator rights. Returns True on success.
Use this method to set a new profile photo for the chat. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set ly returned in getChat requests to check if the bot can use this method. Returns True on success.
OptionalchatId: string | numberUse this method to change the title of a chat. Titles can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
Use this method to set the score of the specified user in a game message. On success, if the message is not an inline message, the Message is returned, otherwise True is returned. Returns an error, if the new score is not greater than the user's current score in the chat and force is False.
OptionalchatRequired if inlineMessageId is not specified. Unique identifier for the target chat
OptionaldisablePass True if the game message should not be automatically edited to include the current scoreboard
Optionalforce?: booleanPass True if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters
OptionalinlineRequired if chatId and messageId are not specified. Identifier of the inline message
OptionalmessageRequired if inlineMessageId is not specified. Identifier of the sent message
New score, must be non-negative
User identifier
By default EventEmitters will print a warning if more than 10 listeners are
added for a particular event. This is a useful default that helps finding
memory leaks. The emitter.setMaxListeners() method allows the limit to be
modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.
Returns a reference to the EventEmitter, so that calls can be chained.
Use this method to change the chosen reactions on a message. Service messages can't be reacted to. Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel. In albums, bots must react to the first message. Returns True on success.
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
OptionalisPass True to set the reaction with a big animation
Identifier of the target message
Optionalreaction?: ReactionType[]A JSON-serialized list of reaction types to set on the message. Currently, as non-premium users, bots can set up to one reaction per message. A custom emoji reaction can be used if it is either already present on the message or explicitly allowed by chat administrators. Paid reactions can't be used by bots.
Use this method to change the list of the bot's commands. See https://core.telegram.org/bots#commands for more details about bot commands. Returns True on success.
A list of bot commands to be set as the list of the bot's commands. At most 100 commands can be specified.
OptionallanguageA two-letter ISO 639-1 language code. If empty, commands will be applied to all users from the given scope, for whose language there are no dedicated commands
Optionalscope?: BotCommandScopeAn object, describing scope of users for which the commands are relevant. Defaults to BotCommandScopeDefault.
Use this method to change the default administrator rights requested by the bot when it's added as an administrator to groups or channels. These rights will be suggested to users, but they are free to modify the list before adding the bot. Returns True on success.
Optionalrights: ChatPermissionFlagsOptionalforChannels: booleanUse this method to change the bot's short description, which is shown on the bot's profile page and is sent together with the link when users share the bot. Returns True on success.
OptionalshortDescription: stringOptionallanguageCode: stringInforms a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns True on success.
Use this if the data submitted by the user doesn't satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues.
Use this method to change search keywords assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns True on success.
Optionalkeywords: string[]Use this method to change the mask position of a mask sticker. The sticker must belong to a sticker set that was created by the bot. Returns True on success.
OptionalmaskPosition: MaskPositionUse this method to set the thumbnail of a regular or mask sticker set. The format of the thumbnail file must match the format of the stickers in the set. Returns True on success.
Format of the thumbnail, must be one of “static” for a .WEBP or .PNG image, “animated” for a .TGS animation, or “video” for a WEBM video
Sticker set name
Optionalthumbnail?: A .WEBP or .PNG image with the thumbnail, must be up to 128 kilobytes in size and have a width and height of exactly 100px, or a .TGS animation with a thumbnail up to 32 kilobytes in size (see https://core.telegram.org/stickers#animation-requirements for animated sticker technical requirements), or a WEBM video with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#video-requirements for video sticker technical requirements. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files ». Animated and video sticker set thumbnails can't be uploaded via HTTP URL. If omitted, then the thumbnail is dropped and the first sticker is used as the thumbnail.
User identifier of the sticker set owner
Use this method to specify a URL and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified URL, containing a JSON-serialized Update. In case of an unsuccessful request, we will give up after a reasonable amount of attempts. Returns True on success.
If you'd like to make sure that the webhook was set by you, you can specify secret data in the parameter secret_token. If specified, the request will contain a header “X-Telegram-Bot-Api-Secret-Token” with the secret token as content.
Notes
If you're having any trouble setting up webhooks, please check out this amazing guide to webhooks.
OptionalallowedA list of the update types you want your bot to receive. For example, specify ["message", "edited_channel_post", "callback_query"] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member, message_reaction, and message_reaction_count (default). If not specified, the previous setting will be used.
Please note that this parameter doesn't affect updates created before the call to the setWebhook, so unwanted updates may be received for a short period of time.
Optionalcertificate?: Upload your public key certificate so that the root certificate in use can be checked. See our self-signed guide for details.
OptionaldropPass True to drop all pending updates
OptionalipThe fixed IP address which will be used to send webhook requests instead of the IP address resolved through DNS
OptionalmaxThe maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. Defaults to 40. Use lower values to limit the load on your bot's server, and higher values to increase your bot's throughput.
OptionalsecretA secret token to be sent in a header “X-Telegram-Bot-Api-Secret-Token” in every webhook request, 1-256 characters. Only characters A-Z, a-z, 0-9, _ and - are allowed. The header is useful to ensure that the request comes from a webhook set by you.
HTTPS URL to send updates to. Use an empty string to remove webhook integration
Use this method to stop updating a live location message before live_period expires. On success, if the message is not an inline message, the edited Message is returned, otherwise True is returned.
OptionalbusinessUnique identifier of the business connection on behalf of which the message to be edited was sent
OptionalchatRequired if inlineMessageId is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)
OptionalinlineRequired if chatId and messageId are not specified. Identifier of the inline message
OptionalmessageRequired if inlineMessageId is not specified. Identifier of the message with live location to stop
OptionalreplyAn object for a new inline keyboard.
Use this method to stop a poll which was sent by the bot. On success, the stopped Poll is returned.
OptionalbusinessUnique identifier of the business connection on behalf of which the message to be edited was sent
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
Identifier of the original message with the poll
OptionalreplyAn object for a new message inline keyboard.
Use this method to unban a previously banned user in a supergroup or channel. The user will not return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will also be removed from the chat. If you don't want this, use the parameter only_if_banned. Returns True on success.
Unique identifier for the target group or username of the target supergroup or channel (in the format @channelusername)
OptionalonlyDo nothing if the user is not banned
Unique identifier of the target user
Use this method to unban a previously banned channel chat in a supergroup or channel. The bot must be an administrator for this to work and must have the appropriate administrator rights. Returns True on success.
Use this method to unhide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.
Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' admin right in a supergroup or 'can_edit_messages' admin right in a channel. Returns True on success.
Use this method to clear the list of pinned messages in a forum topic. The bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success.
Use this method to clear the list of pinned messages in a General forum topic. The bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success.
Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' admin right in a supergroup or 'can_edit_messages' admin right in a channel. Returns True on success.
OptionalbusinessUnique identifier of the business connection on behalf of which the message will be unpinned
Unique identifier for the target chat or username of the target channel (in the format @channelusername)
OptionalmessageIdentifier of the message to unpin. Required if business_connection_id is specified. If not specified, the most recent pinned message (by sending date) will be pinned.
Use this method to upload a file with a sticker for later use in the createNewStickerSet and addStickerToSet methods (the file can be used multiple times). Returns the uploaded File on success.
A file with the sticker in .WEBP, .PNG, .TGS, or .WEBM format. See https://core.telegram.org/stickers for technical requirements.
Format of the sticker, must be one of “static”, “animated”, “video”
User identifier of sticker file owner
StaticaddExperimentalListens once to the abort event on the provided signal.
Listening to the abort event on abort signals is unsafe and may
lead to resource leaks since another third party with the signal can
call e.stopImmediatePropagation(). Unfortunately Node.js cannot change
this since it would violate the web standard. Additionally, the original
API makes it easy to forget to remove listeners.
This API allows safely using AbortSignals in Node.js APIs by solving these
two issues by listening to the event such that stopImmediatePropagation does
not prevent the listener from running.
Returns a disposable so that it may be unsubscribed from more easily.
import { addAbortListener } from 'node:events';
function example(signal) {
let disposable;
try {
signal.addEventListener('abort', (e) => e.stopImmediatePropagation());
disposable = addAbortListener(signal, (e) => {
// Do something when signal is aborted.
});
} finally {
disposable?.[Symbol.dispose]();
}
}
Disposable that removes the abort listener.
StaticgetReturns a copy of the array of listeners for the event named eventName.
For EventEmitters this behaves exactly the same as calling .listeners on
the emitter.
For EventTargets this is the only way to get the event listeners for the
event target. This is useful for debugging and diagnostic purposes.
const { getEventListeners, EventEmitter } = require('events');
{
const ee = new EventEmitter();
const listener = () => console.log('Events are fun');
ee.on('foo', listener);
getEventListeners(ee, 'foo'); // [listener]
}
{
const et = new EventTarget();
const listener = () => console.log('Events are fun');
et.addEventListener('foo', listener);
getEventListeners(et, 'foo'); // [listener]
}
StaticgetReturns the currently set max amount of listeners.
For EventEmitters this behaves exactly the same as calling .getMaxListeners on
the emitter.
For EventTargets this is the only way to get the max event listeners for the
event target. If the number of event handlers on a single EventTarget exceeds
the max set, the EventTarget will print a warning.
import { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events';
{
const ee = new EventEmitter();
console.log(getMaxListeners(ee)); // 10
setMaxListeners(11, ee);
console.log(getMaxListeners(ee)); // 11
}
{
const et = new EventTarget();
console.log(getMaxListeners(et)); // 10
setMaxListeners(11, et);
console.log(getMaxListeners(et)); // 11
}
StaticlistenerA class method that returns the number of listeners for the given eventNameregistered on the given emitter.
const { EventEmitter, listenerCount } = require('events');
const myEmitter = new EventEmitter();
myEmitter.on('event', () => {});
myEmitter.on('event', () => {});
console.log(listenerCount(myEmitter, 'event'));
// Prints: 2
The emitter to query
The event name
Staticonconst { on, EventEmitter } = require('events');
(async () => {
const ee = new EventEmitter();
// Emit later on
process.nextTick(() => {
ee.emit('foo', 'bar');
ee.emit('foo', 42);
});
for await (const event of on(ee, 'foo')) {
// The execution of this inner block is synchronous and it
// processes one event at a time (even with await). Do not use
// if concurrent execution is required.
console.log(event); // prints ['bar'] [42]
}
// Unreachable here
})();
Returns an AsyncIterator that iterates eventName events. It will throw
if the EventEmitter emits 'error'. It removes all listeners when
exiting the loop. The value returned by each iteration is an array
composed of the emitted event arguments.
An AbortSignal can be used to cancel waiting on events:
const { on, EventEmitter } = require('events');
const ac = new AbortController();
(async () => {
const ee = new EventEmitter();
// Emit later on
process.nextTick(() => {
ee.emit('foo', 'bar');
ee.emit('foo', 42);
});
for await (const event of on(ee, 'foo', { signal: ac.signal })) {
// The execution of this inner block is synchronous and it
// processes one event at a time (even with await). Do not use
// if concurrent execution is required.
console.log(event); // prints ['bar'] [42]
}
// Unreachable here
})();
process.nextTick(() => ac.abort());
The name of the event being listened for
Optionaloptions: StaticEventEmitterOptionsthat iterates eventName events emitted by the emitter
StaticonceCreates a Promise that is fulfilled when the EventEmitter emits the given
event or that is rejected if the EventEmitter emits 'error' while waiting.
The Promise will resolve with an array of all the arguments emitted to the
given event.
This method is intentionally generic and works with the web platform EventTarget interface, which has no special'error' event
semantics and does not listen to the 'error' event.
const { once, EventEmitter } = require('events');
async function run() {
const ee = new EventEmitter();
process.nextTick(() => {
ee.emit('myevent', 42);
});
const [value] = await once(ee, 'myevent');
console.log(value);
const err = new Error('kaboom');
process.nextTick(() => {
ee.emit('error', err);
});
try {
await once(ee, 'myevent');
} catch (err) {
console.log('error happened', err);
}
}
run();
The special handling of the 'error' event is only used when events.once()is used to wait for another event. If events.once() is used to wait for the
'error' event itself, then it is treated as any other kind of event without
special handling:
const { EventEmitter, once } = require('events');
const ee = new EventEmitter();
once(ee, 'error')
.then(([err]) => console.log('ok', err.message))
.catch((err) => console.log('error', err.message));
ee.emit('error', new Error('boom'));
// Prints: ok boom
An AbortSignal can be used to cancel waiting for the event:
const { EventEmitter, once } = require('events');
const ee = new EventEmitter();
const ac = new AbortController();
async function foo(emitter, event, signal) {
try {
await once(emitter, event, { signal });
console.log('event emitted!');
} catch (error) {
if (error.name === 'AbortError') {
console.error('Waiting for the event was canceled!');
} else {
console.error('There was an error', error.message);
}
}
}
foo(ee, 'foo', ac.signal);
ac.abort(); // Abort waiting for the event
ee.emit('foo'); // Prints: Waiting for the event was canceled!
Optionaloptions: StaticEventEmitterOptionsOptionaloptions: StaticEventEmitterOptionsStaticsetconst {
setMaxListeners,
EventEmitter
} = require('events');
const target = new EventTarget();
const emitter = new EventEmitter();
setMaxListeners(5, target, emitter);
Optionaln: numberA non-negative number. The maximum number of listeners per EventTarget event.
Rest...eventTargets: (EventEmitter<DefaultEventMap> | _DOMEventTarget)[]
Sets or gets the default captureRejection value for all emitters.