${e}
`:""}var ct=["button","checkbox","file","hidden","image","radio","range","reset","submit"];function ut(){let t=document.activeElement;return t?t.isContentEditable||t.tagName==="TEXTAREA"||t.tagName==="SEARCH"?!0:t.tagName==="INPUT"&&!ct.includes(t.type):!1}var D="mousedown",Me="mousemove",$="mouseup",ne={x:0,y:0},Qe=!1,ce=!1,dt=!1,F=!1,Oe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Oe?"is-mobile":"not-mobile");Oe&&"ontouchstart"in document.documentElement&&(dt=!0,D="touchstart",Me="touchmove",$="touchend");document.addEventListener(D,t=>{ce=!0,F=!1;let e=D=="touchstart"?t.targetTouches[0]:t;ne.y=e.pageY||0,ne.x=e.pageX||0});document.addEventListener(Me,t=>{if(ce&&!F){let e=D=="touchstart"?t.targetTouches[0]:t,n=ne.x-(e.pageX||0),r=ne.y-(e.pageY||0);F=Math.sqrt(n*n+r*r)>10}});document.addEventListener($,()=>{ce=!1});document.addEventListener("click",t=>{Qe&&(t.preventDefault(),t.stopImmediatePropagation(),Qe=!1)});var re=class extends I{active;className;constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener($,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(D,n=>this.onDocumentPointerDown(n)),document.addEventListener($,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){F||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!F&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var ue=new Map,de=class{open;accordions=[];key;constructor(e,n){this.key=e,this.open=n}add(e){this.accordions.push(e),e.open=this.open,e.addEventListener("toggle",()=>{this.toggle(e.open)})}toggle(e){for(let n of this.accordions)n.open=e;S.setItem(this.key,e.toString())}},ie=class extends I{constructor(e){super(e);let n=this.el.querySelector("summary"),r=n.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)});let i=`tsd-accordion-${n.dataset.key??n.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`,s;if(ue.has(i))s=ue.get(i);else{let o=S.getItem(i),a=o?o==="true":this.el.open;s=new de(i,a),ue.set(i,s)}s.add(this.el)}};function He(t){let e=S.getItem("tsd-theme")||"os";t.value=e,Ae(e),t.addEventListener("change",()=>{S.setItem("tsd-theme",t.value),Ae(t.value)})}function Ae(t){document.documentElement.dataset.theme=t}var se;function Ne(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Re),Re())}async function Re(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let e=await R(window.navigationData);se=document.documentElement.dataset.base,se.endsWith("/")||(se+="/"),t.innerHTML="";for(let n of e)Be(n,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Be(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',De(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let c=a.appendChild(document.createElement("ul"));c.className="tsd-nested-navigation";for(let l of t.children)Be(l,c,i)}else De(t,r,t.class)}function De(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));if(r.href=se+t.path,n&&(r.className=n),location.pathname===r.pathname&&!r.href.includes("#")&&(r.classList.add("current"),r.ariaCurrent="page"),t.kind){let i=window.translations[`kind_${t.kind}`].replaceAll('"',""");r.innerHTML=``}r.appendChild(Fe(t.text,document.createElement("span")))}else{let r=e.appendChild(document.createElement("span")),i=window.translations.folder.replaceAll('"',""");r.innerHTML=``,r.appendChild(Fe(t.text,document.createElement("span")))}}function Fe(t,e){let n=t.split(/(?<=[^A-Z])(?=[A-Z])|(?<=[A-Z])(?=[A-Z][a-z])|(?<=[_-])(?=[^_-])/);for(let r=0;rClass TelegramBot
Hierarchy
- EventEmitter
- TelegramBot
Index
Constructors
Properties
Accessors
Methods
[capture
Constructors
constructor
Both request method to obtain messages are implemented. To use standard polling, set
+polling: true+onoptions. Notice that webHook will need a SSL certificate. +Emitsmessagewhen a message arrives.Parameters
- token: string
Bot Token
+ - options: TelegramBotOptions = {}
Returns TelegramBot
- token: string
Accessors
Staticerrors
- get errors(): {
ย ย ย ย BaseError: typeof BaseError;
ย ย ย ย FatalError: typeof FatalError;
ย ย ย ย ParseError: typeof ParseError;
ย ย ย ย TelegramError: typeof TelegramError;
}The different errors the library uses.
+Returns {
ย ย ย ย BaseError: typeof BaseError;
ย ย ย ย FatalError: typeof FatalError;
ย ย ย ย ParseError: typeof ParseError;
ย ย ย ย TelegramError: typeof TelegramError;
}
Staticmessage
- get messageTypes(): MessageType[]
The types of message updates the library handles.
+Returns MessageType[]
Methods
Optional[capture
- "[captureRejectionSymbol]"?(
ย ย ย ย error: Error,
ย ย ย ย event: string | symbol,
ย ย ย ย ...args: any[],
): voidThe
+Symbol.for('nodejs.rejection')method is called in case a +promise rejection happens when emitting an event and +captureRejectionsis enabled on the emitter. +It is possible to useevents.captureRejectionSymbolin +place ofSymbol.for('nodejs.rejection').
+ +import { EventEmitter, captureRejectionSymbol } from 'node:events';
class MyClass extends EventEmitter {
constructor() {
super({ captureRejections: true });
}
[captureRejectionSymbol](err, event, ...args) {
console.log('rejection happened for', event, 'with', err, ...args);
this.destroy(err);
}
destroy(err) {
// Tear the resource down here.
}
} +Parameters
- error: Error
- event: string | symbol
- ...args: any[]
Returns void
add
- addListener<E extends string | symbol>(
ย ย ย ย eventName: string | symbol,
ย ย ย ย listener: (...args: any[]) => void,
): this
answer
- answerCallbackQuery(
ย ย ย ย callbackQueryId: string,
ย ย ย ย options?: Record<string, unknown>,
): Promise<unknown>Use this method to send answers to callback queries
+Parameters
- callbackQueryId: string
Unique identifier for the query to be answered
+ - options: Record<string, unknown> = {}
Additional Telegram query options
+
Returns Promise<unknown>
- callbackQueryId: string
clear
- clearReplyListeners(): {
ย ย ย ย callback: (msg: Message) => void;
ย ย ย ย chatId: string | number;
ย ย ย ย id: number;
ย ย ย ย messageId: number;
}[]Removes all replies that have been prev. registered for a message response.
+Returns {
ย ย ย ย callback: (msg: Message) => void;
ย ย ย ย chatId: string | number;
ย ย ย ย id: number;
ย ย ย ย messageId: number;
}[]deletedListeners An array of removed listeners.
+
clear
Remove all listeners registered with
+onText().Returns void
close
Close webhook. Multiple WebHooks are not supported.
+Returns Promise<void>
Promise
+
delete
- deleteMessage(
ย ย ย ย chatId: string | number,
ย ย ย ย messageId: number,
ย ย ย ย options?: Record<string, unknown>,
): Promise<unknown>Use this method to delete a message
+Parameters
- chatId: string | number
Unique identifier for the target chat
+ - messageId: number
Identifier of the message to delete
+ - options: Record<string, unknown> = {}
Additional Telegram query options
+
Returns Promise<unknown>
- chatId: string | number
delete
Use this method to remove webhook integration if you decide to +switch back to getUpdates.
+Parameters
- options: Record<string, unknown> = {}
Additional Telegram query options
+
Returns Promise<unknown>
Promise
+- options: Record<string, unknown> = {}
edit
edit
- editMessageLiveLocation(
ย ย ย ย latitude: number,
ย ย ย ย longitude: number,
ย ย ย ย options?: Record<string, unknown>,
): Promise<unknown>Edit live location messages
+Parameters
- latitude: number
Latitude of new location
+ - longitude: number
Longitude of new location
+ - options: Record<string, unknown> = {}
Additional Telegram query options
+
Returns Promise<unknown>
- latitude: number
edit
- editMessageReplyMarkup(
ย ย ย ย replyMarkup: unknown,
ย ย ย ย options?: Record<string, unknown>,
): Promise<unknown>Use this method to edit message reply markup
+Parameters
- replyMarkup: unknown
A JSON-serialized object for an inline keyboard
+ - options: Record<string, unknown> = {}
Additional Telegram query options
+
Returns Promise<unknown>
- replyMarkup: unknown
edit
Use this method to edit text messages
+Parameters
- text: string
New text of the message
+ - options: Record<string, unknown> = {}
Additional Telegram query options
+
Returns Promise<unknown>
- text: string
emit
- emit<E extends string | symbol>(
ย ย ย ย eventName: string | symbol,
ย ย ย ย ...args: any[],
): booleanSynchronously calls each of the listeners registered for the event named +
+eventName, in the order they were registered, passing the supplied arguments +to each.Returns
+trueif the event had listeners,falseotherwise.
+ +import { EventEmitter } from 'node: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 +Type Parameters
- E extends string | symbol
Parameters
- eventName: string | symbol
- ...args: any[]
Returns boolean
event
Returns an array listing the events for which the emitter has registered +listeners.
+
+ +import { EventEmitter } from 'node: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) ] +Returns (string | symbol)[]
get
Get information about a chat
+Parameters
- chatId: string | number
Returns Promise<unknown>
get
Get basic info about a file
+Parameters
- fileId: string
File identifier
+ - options: Record<string, unknown> = {}
Additional Telegram query options
+
Returns Promise<unknown>
- fileId: string
get
get
Returns basic information about the bot
+Returns Promise<unknown>
get
Use this method to receive incoming updates using long polling.
+Parameters
- options: GetUpdatesOptions = {}
Options for the getUpdates call
+
Returns Promise<Update[]>
Promise of updates
+- options: GetUpdatesOptions = {}
get
get
Use this method to get current webhook status.
+Parameters
- options: Record<string, unknown> = {}
Additional Telegram query options
+
Returns Promise<unknown>
Promise
+- options: Record<string, unknown> = {}
has
Return true if WebHook is active, false otherwise.
+Returns boolean
Boolean
+
init
is
Return true if polling is active, false otherwise.
+Returns boolean
Boolean
+
listener
- listenerCount<E extends string | symbol>(
ย ย ย ย eventName: string | symbol,
ย ย ย ย listener?: (...args: any[]) => void,
): numberReturns the number of listeners listening for the event named
+eventName. +Iflisteneris provided, it will return how many times the listener is found +in the list of the listeners of the event.Type Parameters
- E extends string | symbol
Parameters
- eventName: string | symbol
The name of the event being listened for
+ Optionallistener: (...args: any[]) => voidThe event handler function
+
Returns number
listeners
- listeners<E extends string | symbol>(
ย ย ย ย eventName: string | symbol,
): ((...args: any[]) => void)[]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] ] +Type Parameters
- E extends string | symbol
Parameters
- eventName: string | symbol
Returns ((...args: any[]) => void)[]
off
- off<E extends string | symbol>(
ย ย ย ย eventName: string | symbol,
ย ย ย ย listener: (...args: any[]) => void,
): this
on
Add listener for the specified event. +This is the usual
+emitter.on()method.Parameters
- event: string | symbol
- listener: (...args: unknown[]) => void
Returns this
once
- once<E extends string | symbol>(
ย ย ย ย eventName: string | symbol,
ย ย ย ย listener: (...args: any[]) => void,
): thisAdds a one-time
+listenerfunction for the event namedeventName. The +next timeeventNameis triggered, this listener is removed and then invoked.
+ +server.once('connection', (stream) => {
console.log('Ah, we have our first user!');
}); +Returns a reference to the
+EventEmitter, so that calls can be chained.By default, event listeners are invoked in the order they are added. The +
+emitter.prependOnceListener()method can be used as an alternative to add the +event listener to the beginning of the listeners array.
+ +import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.once('foo', () => console.log('a'));
myEE.prependOnceListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
// b
// a +Type Parameters
- E extends string | symbol
Parameters
- eventName: string | symbol
The name of the event.
+ - listener: (...args: any[]) => void
The callback function
+
Returns this
on
- onReplyToMessage(
ย ย ย ย chatId: string | number,
ย ย ย ย messageId: number,
ย ย ย ย callback: (msg: Message) => void,
): numberRegister a reply to wait for a message response.
+Parameters
- chatId: string | number
The chat id where the message cames from.
+ - messageId: number
The message id to be replied.
+ - callback: (msg: Message) => void
Callback will be called with the reply message.
+
Returns number
id The ID of the inserted reply listener.
+ - chatId: string | number
on
- onText(
ย ย ย ย regexp: RegExp,
ย ย ย ย callback: (msg: Message, match: RegExpMatchArray | null) => void,
): voidRegister a RegExp to test against an incomming text message.
+Parameters
- regexp: RegExp
RegExp executed with
+exec. - callback: (msg: Message, match: RegExpMatchArray | null) => void
Callback will be called with 2 parameters, +the
+msgand the result of executingregexp.execon message text.
Returns void
- regexp: RegExp
open
Open webhook. +Multiple WebHooks are not supported. +Uses webhook options from TelegramBotOptions.webHook configuration.
+Returns Promise<void>
Promise that resolves when webhook is open
+
prepend
- prependListener<E extends string | symbol>(
ย ย ย ย eventName: string | symbol,
ย ย ย ย listener: (...args: any[]) => void,
): thisAdds the
+listenerfunction to the beginning of the listeners array for the +event namedeventName. No checks are made to see if thelistenerhas +already been added. Multiple calls passing the same combination ofeventName+andlistenerwill result in thelistenerbeing 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.Type Parameters
- E extends string | symbol
Parameters
- eventName: string | symbol
The name of the event.
+ - listener: (...args: any[]) => void
The callback function
+
Returns this
prepend
- prependOnceListener<E extends string | symbol>(
ย ย ย ย eventName: string | symbol,
ย ย ย ย listener: (...args: any[]) => void,
): thisAdds a one-time
+listenerfunction for the event namedeventNameto the +beginning of the listeners array. The next timeeventNameis 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.Type Parameters
- E extends string | symbol
Parameters
- eventName: string | symbol
The name of the event.
+ - listener: (...args: any[]) => void
The callback function
+
Returns this
process
Process an update; emitting the proper events and executing regexp +callbacks. This method is useful should you be using a different +way to fetch updates, other than those provided by TelegramBot.
+Parameters
- update: Update
Update object obtained from Telegram API
+
Returns void
- update: Update
raw
- rawListeners<E extends string | symbol>(
ย ย ย ย eventName: string | symbol,
): ((...args: any[]) => void)[]Returns a copy of the array of listeners for the event named
+eventName, +including any wrappers (such as those created by.once()).
+ +import { EventEmitter } from 'node:events';
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'); +Type Parameters
- E extends string | symbol
Parameters
- eventName: string | symbol
Returns ((...args: any[]) => void)[]
remove
Removes all listeners, or those of the specified
+eventName.It is bad practice to remove listeners added elsewhere in the code, +particularly when the
+EventEmitterinstance 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.Type Parameters
- E extends string | symbol
Parameters
OptionaleventName: string | symbol
Returns this
remove
- removeListener<E extends string | symbol>(
ย ย ย ย eventName: string | symbol,
ย ย ย ย listener: (...args: any[]) => void,
): thisRemoves the specified
+listenerfrom the listener array for the event named +eventName.
+ +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 specifiedeventName, thenremoveListener()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 any +
+removeListener()orremoveAllListeners()calls after emitting and +before the last listener finishes execution will not remove them from +emit()in progress. Subsequent events behave as expected.
+ +import { EventEmitter } from 'node:events';
class MyEmitter extends EventEmitter {}
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 indexes 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 theonce('ping')+listener is removed:
+ +import { EventEmitter } from 'node:events';
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.Type Parameters
- E extends string | symbol
Parameters
- eventName: string | symbol
- listener: (...args: any[]) => void
Returns this
remove
- removeReplyListener(
ย ย ย ย replyListenerId: number,
):
ย ย ย ย | {
ย ย ย ย ย ย ย ย callback: (msg: Message) => void;
ย ย ย ย ย ย ย ย chatId: string | number;
ย ย ย ย ย ย ย ย id: number;
ย ย ย ย ย ย ย ย messageId: number;
ย ย ย ย }
ย ย ย ย | nullRemoves a reply that has been prev. registered for a message response.
+Parameters
- replyListenerId: number
The ID of the reply listener.
+
Returns
ย ย ย ย | {
ย ย ย ย ย ย ย ย callback: (msg: Message) => void;
ย ย ย ย ย ย ย ย chatId: string | number;
ย ย ย ย ย ย ย ย id: number;
ย ย ย ย ย ย ย ย messageId: number;
ย ย ย ย }
ย ย ย ย | nulldeletedListener The removed reply listener if +found. This object has
+id,chatId,messageIdandcallback+properties. If not found, returnsnull. - replyListenerId: number
remove
- removeTextListener(
ย ย ย ย regexp: RegExp,
):
ย ย ย ย | {
ย ย ย ย ย ย ย ย callback: (msg: Message, match: RegExpMatchArray | null) => void;
ย ย ย ย ย ย ย ย regexp: RegExp;
ย ย ย ย }
ย ย ย ย | nullRemove a listener registered with
+onText().Parameters
- regexp: RegExp
RegExp used previously in
+onText()
Returns
ย ย ย ย | {
ย ย ย ย ย ย ย ย callback: (msg: Message, match: RegExpMatchArray | null) => void;
ย ย ย ย ย ย ย ย regexp: RegExp;
ย ย ย ย }
ย ย ย ย | nulldeletedListener The removed reply listener if +found. This object has
+regexpandcallback+properties. If not found, returnsnull. - regexp: RegExp
send
- sendAnimation(
ย ย ย ย chatId: string | number,
ย ย ย ย animation: FileInput,
ย ย ย ย options?: Record<string, unknown>,
ย ย ย ย fileOptions?: { contentType?: string; filename?: string },
): Promise<unknown>Send animation files (GIF or H.264/MPEG-4 AVC video without sound)
+Parameters
- chatId: string | number
Unique identifier for the target chat
+ - animation: FileInput
Animation to send
+ - options: Record<string, unknown> = {}
Additional Telegram query options
+ - fileOptions: { contentType?: string; filename?: string } = {}
Optional file related meta-data
+
Returns Promise<unknown>
- chatId: string | number
send
- sendAudio(
ย ย ย ย chatId: string | number,
ย ย ย ย audio: FileInput,
ย ย ย ย options?: Record<string, unknown>,
ย ย ย ย fileOptions?: { contentType?: string; filename?: string },
): Promise<unknown>Send audio files (MP3 or M4A format)
+Parameters
- chatId: string | number
Unique identifier for the target chat
+ - audio: FileInput
Audio file to send
+ - options: Record<string, unknown> = {}
Additional Telegram query options
+ - fileOptions: { contentType?: string; filename?: string } = {}
Optional file related meta-data
+
Returns Promise<unknown>
- chatId: string | number
send
- sendChatAction(
ย ย ย ย chatId: string | number,
ย ย ย ย action: string,
ย ย ย ย options?: Record<string, unknown>,
): Promise<unknown>Send chat action (typing, uploading, etc.)
+Parameters
- chatId: string | number
Unique identifier for the target chat
+ - action: string
Type of action to broadcast
+ - options: Record<string, unknown> = {}
Additional Telegram query options
+
Returns Promise<unknown>
- chatId: string | number
send
- sendContact(
ย ย ย ย chatId: string | number,
ย ย ย ย phoneNumber: string,
ย ย ย ย firstName: string,
ย ย ย ย options?: Record<string, unknown>,
): Promise<unknown>Send phone contacts
+Parameters
- chatId: string | number
Unique identifier for the target chat
+ - phoneNumber: string
Contact's phone number
+ - firstName: string
Contact's first name
+ - options: Record<string, unknown> = {}
Additional Telegram query options
+
Returns Promise<unknown>
- chatId: string | number
send
- sendDice(
ย ย ย ย chatId: string | number,
ย ย ย ย options?: Record<string, unknown>,
): Promise<unknown>Send an animated emoji (dice, dart, basketball, etc.)
+Parameters
- chatId: string | number
Unique identifier for the target chat
+ - options: Record<string, unknown> = {}
Additional Telegram query options
+
Returns Promise<unknown>
- chatId: string | number
send
- sendDocument(
ย ย ย ย chatId: string | number,
ย ย ย ย doc: FileInput,
ย ย ย ย options?: Record<string, unknown>,
ย ย ย ย fileOptions?: { contentType?: string; filename?: string },
): Promise<unknown>Send general files
+Parameters
- chatId: string | number
Unique identifier for the target chat
+ - doc: FileInput
Document to send
+ - options: Record<string, unknown> = {}
Additional Telegram query options
+ - fileOptions: { contentType?: string; filename?: string } = {}
Optional file related meta-data
+
Returns Promise<unknown>
- chatId: string | number
send
- sendGame(
ย ย ย ย chatId: string | number,
ย ย ย ย gameShortName: string,
ย ย ย ย options?: Record<string, unknown>,
): Promise<unknown>Send a game
+Parameters
- chatId: string | number
Unique identifier for the target chat
+ - gameShortName: string
Short name of the game
+ - options: Record<string, unknown> = {}
Additional Telegram query options
+
Returns Promise<unknown>
- chatId: string | number
send
- sendLocation(
ย ย ย ย chatId: string | number,
ย ย ย ย latitude: number,
ย ย ย ย longitude: number,
ย ย ย ย options?: Record<string, unknown>,
): Promise<unknown>Send location on the map
+Parameters
- chatId: string | number
Unique identifier for the target chat
+ - latitude: number
Latitude of location
+ - longitude: number
Longitude of location
+ - options: Record<string, unknown> = {}
Additional Telegram query options
+
Returns Promise<unknown>
- chatId: string | number
send
- sendMediaGroup(
ย ย ย ย chatId: string | number,
ย ย ย ย media: unknown[],
ย ย ย ย options?: Record<string, unknown>,
): Promise<unknown>Send media group (album of photos and videos)
+Parameters
- chatId: string | number
Unique identifier for the target chat
+ - media: unknown[]
Array of InputMedia to be sent
+ - options: Record<string, unknown> = {}
Additional Telegram query options
+
Returns Promise<unknown>
- chatId: string | number
send
send
- sendPhoto(
ย ย ย ย chatId: string | number,
ย ย ย ย photo: FileInput,
ย ย ย ย options?: Record<string, unknown>,
ย ย ย ย fileOptions?: { contentType?: string; filename?: string },
): Promise<unknown>Send a photo
+Parameters
- chatId: string | number
Unique identifier for the target chat
+ - photo: FileInput
Photo to send (file path, Stream, Buffer, or file_id)
+ - options: Record<string, unknown> = {}
Additional Telegram query options
+ - fileOptions: { contentType?: string; filename?: string } = {}
Optional file related meta-data
+
Returns Promise<unknown>
- chatId: string | number
send
- sendPoll(
ย ย ย ย chatId: string | number,
ย ย ย ย question: string,
ย ย ย ย pollOptions: string[],
ย ย ย ย options?: Record<string, unknown>,
): Promise<unknown>Send a native poll
+Parameters
- chatId: string | number
Unique identifier for the target chat
+ - question: string
Poll question
+ - pollOptions: string[]
Array of answer options
+ - options: Record<string, unknown> = {}
Additional Telegram query options
+
Returns Promise<unknown>
- chatId: string | number
send
- sendSticker(
ย ย ย ย chatId: string | number,
ย ย ย ย sticker: FileInput,
ย ย ย ย options?: Record<string, unknown>,
ย ย ย ย fileOptions?: { contentType?: string; filename?: string },
): Promise<unknown>Send stickers (.WEBP, .TGS, or .WEBM format)
+Parameters
- chatId: string | number
Unique identifier for the target chat
+ - sticker: FileInput
Sticker to send
+ - options: Record<string, unknown> = {}
Additional Telegram query options
+ - fileOptions: { contentType?: string; filename?: string } = {}
Optional file related meta-data
+
Returns Promise<unknown>
- chatId: string | number
send
- sendVenue(
ย ย ย ย chatId: string | number,
ย ย ย ย latitude: number,
ย ย ย ย longitude: number,
ย ย ย ย title: string,
ย ย ย ย address: string,
ย ย ย ย options?: Record<string, unknown>,
): Promise<unknown>Send venue information
+Parameters
- chatId: string | number
Unique identifier for the target chat
+ - latitude: number
Latitude of location
+ - longitude: number
Longitude of location
+ - title: string
Name of the venue
+ - address: string
Address of the venue
+ - options: Record<string, unknown> = {}
Additional Telegram query options
+
Returns Promise<unknown>
- chatId: string | number
send
- sendVideo(
ย ย ย ย chatId: string | number,
ย ย ย ย video: FileInput,
ย ย ย ย options?: Record<string, unknown>,
ย ย ย ย fileOptions?: { contentType?: string; filename?: string },
): Promise<unknown>Send video files (mp4 format)
+Parameters
- chatId: string | number
Unique identifier for the target chat
+ - video: FileInput
Video to send
+ - options: Record<string, unknown> = {}
Additional Telegram query options
+ - fileOptions: { contentType?: string; filename?: string } = {}
Optional file related meta-data
+
Returns Promise<unknown>
- chatId: string | number
send
- sendVideoNote(
ย ย ย ย chatId: string | number,
ย ย ย ย videoNote: FileInput,
ย ย ย ย options?: Record<string, unknown>,
ย ย ย ย fileOptions?: { contentType?: string; filename?: string },
): Promise<unknown>Send video messages (rounded square MPEG4 videos up to 1 minute long)
+Parameters
- chatId: string | number
Unique identifier for the target chat
+ - videoNote: FileInput
Video note to send
+ - options: Record<string, unknown> = {}
Additional Telegram query options
+ - fileOptions: { contentType?: string; filename?: string } = {}
Optional file related meta-data
+
Returns Promise<unknown>
- chatId: string | number
send
- sendVoice(
ย ย ย ย chatId: string | number,
ย ย ย ย voice: FileInput,
ย ย ย ย options?: Record<string, unknown>,
ย ย ย ย fileOptions?: { contentType?: string; filename?: string },
): Promise<unknown>Send voice messages (OGG format with OPUS encoding, or MP3/M4A)
+Parameters
- chatId: string | number
Unique identifier for the target chat
+ - voice: FileInput
Voice file to send
+ - options: Record<string, unknown> = {}
Additional Telegram query options
+ - fileOptions: { contentType?: string; filename?: string } = {}
Optional file related meta-data
+
Returns Promise<unknown>
- chatId: string | number
set
By default
+EventEmitters will print a warning if more than10listeners are +added for a particular event. This is a useful default that helps finding +memory leaks. Theemitter.setMaxListeners()method allows the limit to be +modified for this specificEventEmitterinstance. The value can be set to +Infinity(or0) to indicate an unlimited number of listeners.Returns a reference to the
+EventEmitter, so that calls can be chained.Parameters
- n: number
Returns this
set
- setWebHook(
ย ย ย ย url: string,
ย ย ย ย options?: Record<string, unknown>,
ย ย ย ย fileOptions?: { contentType?: string; filename?: string },
): Promise<unknown>Specify a url to receive incoming updates via an outgoing webhook.
+Parameters
- url: string
URL where Telegram will make HTTP Post. Leave empty to delete webhook.
+ - options: Record<string, unknown> = {}
Additional Telegram query options
+ - fileOptions: { contentType?: string; filename?: string } = {}
Optional file related meta-data
+
Returns Promise<unknown>
Promise
+ - url: string
start
Start polling. +Rejects returned promise if a WebHook is being used by this instance.
+Parameters
- options: { restart?: boolean } = {}
Returns Promise<void>
Promise
+
stop
Stop updating live location
+Parameters
- options: Record<string, unknown> = {}
Additional Telegram query options
+
Returns Promise<unknown>
- options: Record<string, unknown> = {}
stop
Stops polling
+Parameters
- options: { cancel?: boolean; restart?: boolean } = {}
Returns Promise<void>
Promise
+
diff --git a/docs/hierarchy.html b/docs/hierarchy.html
new file mode 100644
index 00000000..eaded8ec
--- /dev/null
+++ b/docs/hierarchy.html
@@ -0,0 +1 @@
+
node-telegram-bot-api - v0.67.0
Hierarchy Summary
node-telegram-bot-api - v0.67.0
Node.js Telegram Bot API
+ +
๐ฆ Install
+npm i node-telegram-bot-api
++
++โ๏ธ Note: If you use Typescript you can install this package that contains type definitions for this library
++ +npm install --save-dev @types/node-telegram-bot-api +
๐ Usage
+const TelegramBot = require('node-telegram-bot-api');
// replace the value below with the Telegram token you receive from @BotFather
const token = 'YOUR_TELEGRAM_BOT_TOKEN';
// Create a bot that uses 'polling' to fetch new updates
const bot = new TelegramBot(token, {polling: true});
// Matches "/echo [whatever]"
bot.onText(/\/echo (.+)/, (msg, match) => {
// 'msg' is the received Message from Telegram
// 'match' is the result of executing the regexp above on the text content
// of the message
const chatId = msg.chat.id;
const resp = match[1]; // the captured "whatever"
// send back the matched "whatever" to the chat
bot.sendMessage(chatId, resp);
});
// Listen for any kind of message. There are different kinds of
// messages.
bot.on('message', (msg) => {
const chatId = msg.chat.id;
// send a message to the chat acknowledging receipt of their message
bot.sendMessage(chatId, 'Received your message');
});
+๐ Documentation
+-
+
- Usage +
- Examples +
- Tutorials +
- Help Information +
- API Reference: (api-release / development / experimental) +
- Contributing to the Project +
- Experimental Features +
Note: Development is done against the development branch. +Code for the latest release resides on the master branch. +Experimental features reside on the experimental branch.
+๐ญ Community
+We thank all the developers in the Open-Source community who continuously +take their time and effort in advancing this project. +See our list of contributors.
+We have a Telegram channel where we post updates on +the Project. Head over and subscribe!
+We also have a Telegram group to discuss issues related to this library.
+Some things built using this library that might interest you:
+-
+
- tgfancy: A fancy, higher-level wrapper for Telegram Bot API +
- node-telegram-bot-api-middleware: Middleware for node-telegram-bot-api +
- teleirc: A simple Telegram โ IRC gateway +
- bot-brother: Node.js library to help you easily create telegram bots +
- redbot: A Node-RED plugin to create telegram bots visually +
- node-telegram-keyboard-wrapper: A wrapper to improve keyboards structures creation through a more easy-to-see way (supports Inline Keyboards, Reply Keyboard, Remove Keyboard and Force Reply) +
- beetube-bot: A telegram bot for music, videos, movies, EDM tracks, torrent downloads, files and more. +
- telegram-inline-calendar: Date and time picker and inline calendar for Node.js telegram bots. +
- telegram-captcha: Telegram bot to protect Telegram groups from automatic bots. +
๐ฅ Contributors
+
+
+
+
+
License
+The MIT License (MIT)
+Copyright ยฉ 2019 Yago
+
diff --git a/docs/variables/errors.html b/docs/variables/errors.html
new file mode 100644
index 00000000..f774c8cd
--- /dev/null
+++ b/docs/variables/errors.html
@@ -0,0 +1,6 @@
+
Variable errorsConst
errors: {
ย ย ย ย BaseError: typeof BaseError;
ย ย ย ย FatalError: typeof FatalError;
ย ย ย ย ParseError: typeof ParseError;
ย ย ย ย TelegramError: typeof TelegramError;
} = ...
ย ย ย ย BaseError: typeof BaseError;
ย ย ย ย FatalError: typeof FatalError;
ย ย ย ย ParseError: typeof ParseError;
ย ย ย ย TelegramError: typeof TelegramError;
} = ...
Collection of all error classes used by the Telegram Bot API library. +Provides convenient access to all error types for error handling and type checking.
+Type Declaration
BaseError: typeof BaseError
FatalError: typeof FatalError
ParseError: typeof ParseError
TelegramError: typeof TelegramError
TelegramBot allows you to interact with the Telegram Bot API. +Main class for creating and managing a Telegram bot. Supports both polling and webhook +modes for receiving updates, and provides methods for all Telegram Bot API endpoints.
+See
Bot API Documentation
+Example
+ +