telebot-ts API Documentation - v1.0.0
    Preparing search index...

    Class ChatMemberHandler<C, R>

    Handler for chat membership changes (chat_member and my_chat_member updates).

    const memberHandler = new ChatMemberHandler(async (update, context) => {
      console.log("Chat member updated:", update.chat_member?.new_chat_member.status);
    }, ChatMemberHandler.CHAT_MEMBER);

    Type Parameters

    Hierarchy (View Summary)

    Index
    constructor
    callback chatMemberTypes ANY CHAT_MEMBER MY_CHAT_MEMBER
    checkUpdate handleUpdate

    • Constructs a new ChatMemberHandler.

      Type Parameters

      • C extends CallbackContext<
            Record<string, unknown>,
            Record<string, unknown>,
            Record<string, unknown>,
        > = CallbackContext<
            Record<string, unknown>,
            Record<string, unknown>,
            Record<string, unknown>,
        >

        Type of the callback context.

      • R = unknown

        Return value type.

      Parameters

      • callback: HandlerCallback<C, R>

        Function invoked when the update matches.

      • chatMemberTypes: number = ChatMemberHandler.ANY

        Type filter mask (CHAT_MEMBER, MY_CHAT_MEMBER, or ANY).

      Returns ChatMemberHandler<C, R>

      ChatMemberHandler.ANY

    callback: HandlerCallback<C, R>

    The underlying callback function to invoke on match.

    chatMemberTypes: number

    Filter mask specifying which chat member updates to handle.

    ANY: 3

    Target any chat member update

    CHAT_MEMBER: 1

    Target only member updates of other users (chat_member)

    MY_CHAT_MEMBER: 2

    Target only updates for the bot itself (my_chat_member)

    • Checks whether the update matches the requested chat member types.

      Parameters

      • update: Update

        The update to test.

      Returns Promise<boolean>

      true if update matches.

    • Executes the registered handler callback with the given update and context.

      Parameters

      • update: Update

        The Telegram update to process.

      • context: C

        Callback context instance.

      Returns Promise<R>

      The value returned by the callback function.

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods