@itd-api/chat-bot / ChatBot
Class: ChatBot<Client, C>
Defined in: packages/chat-bot/src/bot.ts:106
Команды и цепочка обработчиков поверх событий чатов полного клиента.
Example
const bot = new ChatBot(itd);
bot.command('start', (ctx) => ctx.reply('Привет!'));
await bot.start();Type Parameters
Client
Client extends ChatBotClient = ItdClient
C
C extends ChatContext<Client> = ChatContext<Client>
Implements
Constructors
Constructor
new ChatBot<Client, C>(itd, ...__namedParameters): ChatBot<Client, C>;Defined in: packages/chat-bot/src/bot.ts:121
Для расширенного контекста передайте createContext.
Parameters
itd
Client
__namedParameters
...ChatContext<Client> extends C ? [ChatBotOptions<Client, C>] : [ChatBotOptions<Client, C>]
Returns
ChatBot<Client, C>
Properties
itd
readonly itd: Client;Defined in: packages/chat-bot/src/bot.ts:112
Клиент бота. Доступен в обработчиках как ctx.itd.
Accessors
stream
Get Signature
get stream(): ChatEvents;Defined in: packages/chat-bot/src/bot.ts:150
Канал событий, который бот использует для получения обновлений.
Returns
ChatEvents
Methods
catch()
catch(handler): this;Defined in: packages/chat-bot/src/bot.ts:201
Устанавливает обработчик ошибок для цепочки бота.
Parameters
handler
Returns
this
command()
command(command, ...middleware): this;Defined in: packages/chat-bot/src/bot.ts:185
Распознаёт входящую /команду и передаёт её аргументы в ctx.args.
Parameters
command
string | readonly string[]
middleware
...readonly ChatMiddlewareLike<ChatCommandContext<C>>[]
Returns
this
drain()
drain(): Promise<void>;Defined in: packages/chat-bot/src/bot.ts:235
После stop() ждёт обработчики и канал. Вызывайте вне цепочки обработчиков.
Returns
Promise<void>
filter()
Call Signature
filter<N>(predicate, ...middleware): this;Defined in: packages/chat-bot/src/bot.ts:161
Добавляет обработчики для событий, прошедших условие.
Type Parameters
N
N extends ChatContext<Client>
Parameters
predicate
EventTypeGuard<N, C>
middleware
...readonly ChatMiddlewareLike<N>[]
Returns
this
Call Signature
filter(predicate, ...middleware): this;Defined in: packages/chat-bot/src/bot.ts:165
Добавляет обработчики для событий, прошедших условие.
Parameters
predicate
EventFilter<C>
middleware
...readonly ChatMiddlewareLike<C>[]
Returns
this
hears()
hears(trigger, ...middleware): this;Defined in: packages/chat-bot/src/bot.ts:193
Обрабатывает точное совпадение текста или совпадение с регулярным выражением.
Parameters
trigger
middleware
...readonly ChatMiddlewareLike<ChatHearsContext<C>>[]
Returns
this
middleware()
middleware(): ChatMiddleware<C>;Defined in: packages/chat-bot/src/bot.ts:207
Возвращает обработчик цепочки для подключения к другому боту.
Returns
Implementation of
on()
on<F>(query, ...middleware): this;Defined in: packages/chat-bot/src/bot.ts:172
Добавляет обработчики для типа события или фильтра по сообщению.
Type Parameters
F
F extends ChatBotFilter
Parameters
query
F | readonly F[]
middleware
...readonly ChatMiddlewareLike<ChatFilterContext<C, F>>[]
Returns
this
start()
start(since?): Promise<void>;Defined in: packages/chat-bot/src/bot.ts:216
Подписывается на события и подключает канал. Повторный вызов использует ту же подписку.
Parameters
since?
number
номер последнего обработанного события или eventSeq из списка чатов
Returns
Promise<void>
stop()
stop(): void;Defined in: packages/chat-bot/src/bot.ts:228
Отключает канал и отменяет запросы текущего запуска. Можно вызвать внутри обработчика.
Returns
void
use()
use(...middleware): this;Defined in: packages/chat-bot/src/bot.ts:155
Добавляет middleware в общую цепочку.
Parameters
middleware
...readonly ChatMiddlewareLike<C>[]
Returns
this