Available methods

leaveChat()

Use this method for your bot to leave a group, supergroup or channel. Returns True on success.

parameters

parametertyperequireddescription
chat_idnumber | stringrequiredUnique identifier for the target chat or username of the target supergroup or channel in the format @username. Channel direct messages chats aren't supported; leave the corresponding channel instead.

returns

boolean

usage in yaebal

not (yet) hard-typed on Api — call it through the generic .call<T>() escape hatch documented in @yaebal/types.

bot.ts
import type { LeaveChatParams } from "@yaebal/types";

await bot.api.call<boolean>("leaveChat", {
  chat_id: 123456789,
} satisfies LeaveChatParams);

context shortcut

also available as ctx.leaveChat() on 16 context types — see @yaebal/contexts.

context shortcut
/** Use this method for your bot to leave a group, supergroup or channel. Returns *True* on success. */
ctx.leaveChat(params?: Omit<LeaveChatParams, "chat_id">)