@twitchfy/chatbot/dist/structures/managers/ChatBotTimeoutManager.d.ts

A powerful node module to make your own Twitch ChatBot

import { Base } from '../Base';
import type { ChatBot } from '../ChatBot';
import type { EventSubConnection } from '../../enums';
import type { TimeoutOptions } from '../../interfaces';
/**
 * The timeout manager of the chatbot.
 */
export declare class ChatBotTimeoutManager<T extends EventSubConnection> extends Base<T> {
    /**
     * Creates a new instance of the timeout manager.
     * @param chatbot The current instance of the chatbot.
     */
    constructor(chatbot: ChatBot<T>);
    /**
     * Timeout a specific user.
     * @param chatroomId The id of the chatroom where the user will be sent into a timeout.
     * @param options The options required for send an user into a timeout. See {@link Timeout}.
     * @returns A class representation of the timeout. See {@link Ban}.
     */
    add(chatroomId: string, options: TimeoutOptions): Promise<void>;
    /**
     * Deletes the timeout of a specific user.
     * @param chatroomId The id of the chatroom where the user will be removed from the timeout.
     * @param userId The id of the user to remove from the timeout.
     * @returns
     */
    delete(chatroomId: string, userId: string): Promise<void>;
}